2002-11-27 16:49:10 -06:00
|
|
|
|
|
2003-03-14 17:59:25 -06:00
|
|
|
|
/*! \mainpage GnuCash design and developer's reference
|
2002-11-27 16:49:10 -06:00
|
|
|
|
|
|
|
|
|
|
\section intro Introduction
|
2003-03-14 17:59:25 -06:00
|
|
|
|
|
|
|
|
|
|
This is the new GnuCash developer 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.
|
2002-11-27 16:49:10 -06:00
|
|
|
|
|
|
|
|
|
|
\section hacking Hacking on this documentation
|
2003-03-14 17:59:25 -06:00
|
|
|
|
|
|
|
|
|
|
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. This main page can
|
|
|
|
|
|
be found in src/doc/doxygen_main_page.c .
|
2002-11-27 16:49:10 -06:00
|
|
|
|
|
|
|
|
|
|
\subsection config Editing Doxygen configuration
|
2003-03-14 17:59:25 -06:00
|
|
|
|
|
2002-11-27 16:49:10 -06:00
|
|
|
|
To edit the doxygen configuration, you can use:
|
|
|
|
|
|
*
|
|
|
|
|
|
cd src/doc
|
|
|
|
|
|
*
|
|
|
|
|
|
doxywizard doxygen.cfg &
|
|
|
|
|
|
|
|
|
|
|
|
\subsection reference Doxygen reference documentation
|
2003-03-14 17:59:25 -06:00
|
|
|
|
|
2002-11-27 16:49:10 -06:00
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
|
\section contact Contacts
|
|
|
|
|
|
|
|
|
|
|
|
\subsection web Web Site
|
|
|
|
|
|
News about GnuCash as well as the latest version can always be found at http://www.gnucash.org/
|
|
|
|
|
|
|
|
|
|
|
|
\subsection email 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<EFBFBD>goire mailto:bock@step.polymtl.ca
|
|
|
|
|
|
*/
|
