Changeset View
Changeset View
Standalone View
Standalone View
doc/developer-notes.md
Show First 20 Lines • Show All 101 Lines • ▼ Show 20 Lines | |||||
// | // | ||||
// ... text ... | // ... text ... | ||||
// | // | ||||
``` | ``` | ||||
A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html, | A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html, | ||||
but if possible use one of the above styles. | but if possible use one of the above styles. | ||||
To build doxygen locally to test changes to the Doxyfile or visualize your comments before landing changes: | |||||
``` | |||||
# at the project root, call: | |||||
doxygen doc/Doxyfile | |||||
# output goes to doc/doxygen/html/ | |||||
``` | |||||
Development tips and tricks | Development tips and tricks | ||||
--------------------------- | --------------------------- | ||||
**compiling for debugging** | **compiling for debugging** | ||||
Run configure with the --enable-debug option, then make. Or run configure with | Run configure with the --enable-debug option, then make. Or run configure with | ||||
CXXFLAGS="-g -ggdb -O0" or whatever debug flags you need. | CXXFLAGS="-g -ggdb -O0" or whatever debug flags you need. | ||||
▲ Show 20 Lines • Show All 410 Lines • Show Last 20 Lines |