Using Doxygen for API documentation

Version 3 (Trond Lossius, 2009-08-24 05:13 pm) → Version 4/11 (Trond Lossius, 2009-08-24 05:13 pm)

h1. Using Doxygen

"Doxygen":http://www.stack.nl/~dimitri/doxygen/ is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D. It is used for documenting parts of the source code for the various Jamoma projects, although not as much as we would like to...

h2. Setting up Doxygen

To use it, you will have to download and install:

* "Doxygen":http://www.stack.nl/~dimitri/doxygen/ - version 1.6.0 or later
* Graphviz
** "Graphviz for Mac OSX":http://www.ryandesign.com/graphviz/ - we currently use version 2.14.1
** "graphviz for "Windows":http://www.graphviz.org/Download_windows.php

h2. Generating Doxygen documentation

_This description was written using Mac, but hopefully it is similar on Windows._

# Open the Doxygen application
# From the *File* menu, choose *Open...* and inside your local clone of the GIT repository locate e.g. @/Modules/Foundations/documentation/Doxfile@
# All settings should be fine, so go to the *Run* tab and click the *Run doxygen* button. If you have generated documentation previously, you might want to throw out the @/Modules/Foundations/documentation/html/@ folder first.

h2. Using Doxygen documentation