Developer Documentation

Be sure to have installed doxygen and graphviz.
( sudo apt-get install doxygen graphviz ), or equivalent installation steps for doxygen & graphviz on your chosen platform.

Place the “doxy” directory as a sibling to “src”, “share”, “profiles”.
mkdir doxy
mkdir doxy/critter-html

Once the above steps are complete, here is a ready-made doxygen config file:
http://gist.github.com/331809
Place the doxygen config file in “doxy/”

Now execute doxygen:
cd doxy/
doxygen CONFIG_FILE
(replace “CONFIG_FILE” with whatever name you used when you saved http://gist.github.com/331809)

When doxygen is finished, the documentation will be ready for browsing at doxy/critter-html/html/index.html

You may notice that in http://gist.github.com/331809 the following exclusion is being applied on line 580:
EXCLUDE_PATTERNS = .svn .deps .libs ftgl bullet

It is important to exclude the subdirectories for ftgl and bullet, otherwise the HTML pages generated by doxygen will be dominated by information on ftgl and bullet, which are third-party dependencies of Critterding.