...
- On Ubuntu and related Linux distros, you can use `sudo apt-get install doxygen` (note that graphviz may be a dependency)
- On Mac OS X, we recommend using MacPorts, e.g. `sudo port install doxygen`
- Apparently Doxygen On Windows binaries exist, but we haven't tried them yet, download and run the installer from the Doxygen download page.
Using Doxygen
Once you have Doxygen installed, usage could not be simpler. In a terminal with your current directory set to `GUI/Source`, make a directory called `Docs`. Then, simply type `doxygen Doxyfile` at the prompt. This will pull all documentation comments from the header files and convert them to HTML. The docs can be viewed by opening the `GUI/Source/Docs/html/index.html` file in a web browser.
Each header file has a section after the "includes" that looks like this (note the two asterisks after the first slash):
...
Once again, these are automatically discovered by Doxygen and pulled into the documentation.You can view the docs by opening the `Docs/html/index.html` file in a web browser.
Configuring Doxygen
All the configuration information is contained in the Doxyfile. The extensive comments in the Doxyfile explain what each of the options does.
...