diff --git a/doc/developer-notes.md b/doc/developer-notes.md --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -107,6 +107,13 @@ 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. +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 ---------------------------