(Jamoma Platform)

h1. Using Doxygen for API Documentation

"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. Instructions on how to set up Graphviz with Mountain Lion can be found below.

** "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

* A number of articles on Doxygen can be found "here":http://www.stack.nl/~dimitri/doxygen/articles.html.

* Online Doxygen documentation of the Jamoma projects is available "here":http://www.jamoma.org/api-documentation/index.html.

h2. Setting up Graphviz with OSX Mountain Lion

# Open Terminal and type @which dot@

# If you get a reply to this, Graphviz is already installed.

# If not you can install it using either Homebrew or MacPorts.

## Homebrew:

### Install homebrew according to instructions "here":http://mxcl.github.com/homebrew/.

### Install Graphviz by running the terminal command @brew install graphviz@

## MacPorts:

### Install macPorts according to instructions "here":http://www.macports.org.

### Remember to run the command @sudo port selfupdate@

### Install Graphviz using the command @sudo port install graphviz@

# Once Graphviz is installed you'll need to tell Doxygen where to look for it:

## IN Terminal, type the command @which dot@

## In Doxygen, provide the path to Graphviz as illustrated below.