First of all, is anyone using our doxygen docs, or does anyone care about the format?

Our current usage is a bit inefficient, so I've been thinking of cleaning it up a bit. First on the hit list are those annoying "@brief" instances.

Or config file has this:

# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.)

JAVADOC_AUTOBRIEF = YES

So that means instead of :

/** * @brief XML - prefs observer bridge * * This is an XML node observer that watches for changes in the XML document storing the preferences. * It is used to implement preference observers. */

We can do:

/** * XML - prefs observer bridge. * * This is an XML node observer that watches for changes in the XML document storing the preferences. * It is used to implement preference observers. */

The key point is to just have a single period so that the first sentence *is* the brief description. No need for additional work or @ tags.