- Generate documentation from source code: Doxygen
| File | Description |
|---|---|
| Doxyfile | Doxygen file/settings |
| DoxygenFiles/doxygen-custom.css | custom CSS file |
| DoxygenFiles/header.html | custom HTML header |
| DoxygenFiles/footer.html | custom HTML footer |
| Mainpage.md | main page for Doxygen documentation |
- the doxygen documentation generation is included into the Makefile:
make doc, which corresponds todoxygen ./doc/Doxyfile &> ./doc/doxygen.logcp -r "./doc/html/" "./docs/"
- open in your local browser
- either
docs/index.html - or
doc/html/index.html
- either