There are two Doxygen options which are currently off, that probably ought to be on.
The first is EXTRACT_STATIC, which causes Doxygen to actually show all the static functions we've so carefully documented. Currently, the documentation for them is simply invisible (at least from the Doxygen view). The second is slightly more controversial -- JAVADOC_AUTOBRIEF. It causes Doxygen to treat the first sentence of the documentation as a brief summary, and display it as such (inline, in lists, etc.) Without it, such brief summaries need to be explicitly marked with the @brief command. I think turning it on is a good idea, because it leverages the existing (non @brief-using) documentation we have. A patch, making these two changes, is attached. Jesse
=== modified file 'src/doc/doxygen.cfg.in' --- src/doc/doxygen.cfg.in 2009-04-09 11:29:46 +0000 +++ src/doc/doxygen.cfg.in 2010-02-25 08:33:36 +0000 @@ -137,7 +137,7 @@ # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style @@ -296,7 +296,7 @@ # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation.
_______________________________________________ gnucash-devel mailing list [email protected] https://lists.gnucash.org/mailman/listinfo/gnucash-devel
