Generating Doxygen Documentation

This page goes over the steps required to generate Doxygen documentation from code that was written with our best practices.

1. Open the Doxygen GUI, “doxywizard”, by opening the Windows Start Menu, typing “doxywizard” into the prompt, and hitting Enter.
2. Hit the Select button for selecting the folder with which Doxygen will run.
3. In the dialog box that opens, select where in your repository you would like Doxygen to put the generated documentation and click Select Folder.
4. Enter the project name and description in the prompts.
5. Click the Select... button for specifying the directory where the project’s source code is.
6. Select the source code directory for your project in the dialog box and click the Select Folder button.
7. In the main GUI menu, select the Scan recursively checkbox.
8. Press the Select... button to choose the directory where the generated documentation will go.
9. Click the Select Folder button on the pop-up dialog. You won’t have to select a new folder if you followed step 3 correctly.
10. Click the Next button to advance to the “Mode” menu.
11. Select the “All Entities”, “Include cross-referenced source code in the output”, and “Optimize for Java or C# output” options and click the Next button to advance the the “Output” menu.
12. Under the “HTML” options, select “with navigation panel”. Deselct the “LaTeX” option. Click the Next button to advance the “Diagrams” menu.
13. Click the Next button to advance to the “Run” menu. You don’t need to do any customization here.
14. Click the Run Doxygen button and allow Doxygen to run.
15. Click the Show HTML output button.
16. Verify that the documentation was generated correctly. And begin exploring your documented code!

---