Using Doxygen for API documentation

Version 4 (Trond Lossius, 2009-08-24 05:13 pm)

1 1 Trond Lossius
h1. Using Doxygen
2 1 Trond Lossius
3 1 Trond Lossius
"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...
4 1 Trond Lossius
5 4 Trond Lossius
h2. Setting up Doxygen
6 4 Trond Lossius
7 1 Trond Lossius
To use it, you will have to download and install:
8 1 Trond Lossius
9 1 Trond Lossius
* "Doxygen":http://www.stack.nl/~dimitri/doxygen/ - version  1.6.0 or later
10 1 Trond Lossius
* Graphviz
11 1 Trond Lossius
** "Graphviz for Mac OSX":http://www.ryandesign.com/graphviz/ - we currently use version 2.14.1
12 1 Trond Lossius
** "graphviz for "Windows":http://www.graphviz.org/Download_windows.php
13 1 Trond Lossius
14 1 Trond Lossius
h2. Generating Doxygen documentation
15 1 Trond Lossius
16 3 Trond Lossius
_This description was written using Mac, but hopefully it is similar on Windows._
17 1 Trond Lossius
18 1 Trond Lossius
# Open the Doxygen application
19 1 Trond Lossius
# From the *File* menu, choose *Open...* and inside your local clone of the GIT repository locate e.g. @/Modules/Foundations/documentation/Doxfile@
20 1 Trond Lossius
# 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.
21 1 Trond Lossius
22 1 Trond Lossius
h2. Using Doxygen documentation