Doxygen

From GnuCash
Revision as of 09:21, 22 November 2013 by Fell (talk | contribs) (Creating the Source Documentation)
Jump to: navigation, search

Doxygen is the central point for source documentation at this moment (January 2011).

It is a software which extracts (special) comments from sourcecode to produce source documentation.

This is done and put online on a regular basis at http://svn.gnucash.org/docs/HEAD/.

Creating the Source Documentation

It can be run on your local copy of the sources by

./configure --enable-doxygen --enable-html-docs
make doc

This will populate $BUILDDIR/src/doc. Problems will be logged there to doxygen.log. The HTML docs can be found in its subdir html.

Links