Josh Sled wrote:

I'm not sure how to use doxygen for architectural docs...  Could you
provide an example or pointers to docs that describe it?

http://www.stack.nl/~dimitri/doxygen/commands.html


Using \defgroup , \addtogroup , \example , \mainpage and \file , and a
bit of convention, one could build higher-level structural docs
along-side the lower level file/function/variable docs.

Just a thought about how I usually add "extra" documentation pages (the result is similar to the pages shown here http://simthetic.sourceforge.net/simthetic/api-doc/html/pages.html ):


1. Create a new text file with your documentation text

2. At the beginning and end of this text file, insert the c comments for doxygen, i.e.

/** \page page_label My extra documentation page

[... text goes here ... ]

*/

3. Add the file name of the text file to the INPUT tag of the doxygen configuration file (Doxyfile). That's it.

4. Potentially, use more doxygen commands inside that text file, e.g. \section and \subsection.

Christian


_______________________________________________ gnucash-devel mailing list [EMAIL PROTECTED] https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Reply via email to