overte-HifiExperiments/tools/doxygen

C++ Documentation Generation

Doxygen is used for generating documentation on parts of the C++ code.

Prerequisites

Doxygen ≥ 1.9.1 - https://www.doxygen.nl/

If you want to run Doxygen from a command prompt, add the Doxygen install's /bin directory to your system PATH.

Documenting

See section 4.3.6 of the Coding Standard.

Running

Using the Doxywizard GUI

In the Doxywizard program:

• File > Open /tools/doxygen/Doxyfile.
• In the "Run" tab, click the "Run Doxygen" button.
• Once it has compiled the documentation (this may take a while), click "Show HTML Output" to view the documentation generated.

From a command prompt

Change to the /tools/doxygen/ directory.

doxygen Doxyfile

Output files are generated in a /build/docs/html/ directory. See the index.html file there.

Tips

• The source code directory listed in the "Wizard" tab is only one of the directories scanned. For the full list, see the "Expert" tab's input category's settings.
• The output directory is not wiped each time you run Doxygen, so you may want to periodically clear it out if you're finding it contains old, unwanted files.
• If you want to iterate on a particular part of the documentation, you can temporarily change the "Source code directory" option in the "Wizard" tab of the Doxywizard program.

Altering the Doxygen configuration

This is most easily accomplished by using the Doxyfile GUI and using it to write a new Doxyfile file. Alternatively, you can edit the Doxyfile configuration file in a text editor.

References

• Doxygen Website
• Doxygen Tutorial
• Complete Guide On Using Doxygen