« Previous - Version 9/11 (diff) - Next » - Current version
Trond Lossius, 2012-08-27 02:00 pm


Using Doxygen for API Documentation

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...

Setting up Doxygen

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

  • Doxygen - version 1.6.0 or later
  • Graphviz
    • Graphviz for Mac OSX - we currently use version 2.14.1. Instructions on how to set up Graphviz with Mountain Lion can be found below.
    • "graphviz for Windows

Generating Doxygen documentation

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

  1. Open the Doxygen application
  2. From the File menu, choose Open... and inside your local clone of the GIT repository locate e.g. /Modules/Foundations/documentation/Doxfile
  3. 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.

Using Doxygen documentation

  • A number of articles on Doxygen can be found here.
  • Online Doxygen documentation of the Jamoma projects is available here.

Setting up Graphviz with OSX Mountain Lion

  1. Open Terminal and type which dot
  2. If you get a reply to this, Graphviz is already installed.
  3. If not you can install it using either Homebrew or MacPorts.
    1. Homebrew:
      1. Install homebrew according to instructions here.
      2. Install Graphviz by running the terminal command brew install graphviz
    2. MacPorts:
      1. Install macPorts according to instructions here.
      2. Remember to run the command sudo port selfupdate
      3. Install Graphviz using the command sudo port install graphviz
  4. Once Graphviz is installed you'll need to tell Doxygen where to look for it:
    1. IN Terminal, type the command which dot
    2. In Doxygen, provide the path to Graphviz as illustrated below:

<img src="http://redmine.jamoma.org/attachments/177/Screen_Shot_2012-08-27_at_1.57.04_PM.png" width="80%25" />

Screen_Shot_2012-08-27_at_1.57.04_PM.png (295 KB) Trond Lossius, 2012-08-27 01:58 pm

graphvizSetup.png - Graphviz Setup (287 KB) Trond Lossius, 2012-08-27 02:03 pm