Main Page Modules Alphabetical List Data Structures File List Data Fields Globals

# GnuCash design and developer's manual

## Introduction

This is the new GnuCash developper and design manual for GnuCash. Previous documentation will slowly be integrated into this, and eventually it should always be up to date since it is generated directly from the source files using Doxygen.

## Hacking on this documentation

I will eventually post a style guide for documenting, and document one of the files "by the book". Until then, feel free to start documenting or playing with doxygen configuration.

### Editing Doxygen configuration

To edit the doxygen configuration, you can use:

cd src/doc

doxywizard doxygen.cfg &

### Doxygen reference documentation

The Doxygen web site (http://www.stack.nl/~dimitri/doxygen/) has a complete user manual. For the impatient, here are the most interesting sections:

- How to write documentation blocks for files, functions, variables, etc.: http://www.stack.nl/~dimitri/doxygen/docblocks.html. Do not forget to add a file documentation block (@file) at the top of your file, otherwise, your documentation will not appear in the html.
- List of the special commands you can use within your documentation blocks: http://www.stack.nl/~dimitri/doxygen/commands.html

## Contacts

### Web Site

News about GnuCash as well as the latest version can always be found at http://www.gnucash.org/

### Email

If you have any suggestions concerning this documentation, do not hesitate to send suggestions to gnucash-devel (see http://www.gnucash.org/en/lists.phtml for details)

Benoit Grégoire mailto:bock@step.polymtl.ca