#DOXYGEN DOCUMENTATION EXAMPLE MANUAL#

! A class that simulates a bag of popcorn. Thus, to document a BagOfPopcorn class with both a brief and a detailed description, one could do something like the following: Documenting parameter directions may play a bigger role in case of other languages that lack these additional constructs in function signatures. Note that unless you set 'JAVADOC_AUTOBRIEF = NO' in your config files (which I always do :), the JavaDoc versions will try to perform some funky magic behind your back and treat the first sentence in a JavaDoc comment up to the first period as the brief description if you think this is a good thing, just leave your config files alone :)Īt any rate, when Doxygen parses through your files, it applies the descriptions in your Doxygen comments to the immediately preceding declaration or definition in the source file. Thus, marking it in the DoxyPress documentation is a bit redundant, not expressive enough (as your example shows), and may get out of sync with the implementation. Each description is optional, but an item may have no more than one of each type of description. Each comment represents a description for some entity in your code (meaning a class, or a function, or a variable, etc.), and there are two types of descriptions: brief and detailed.

#DOXYGEN DOCUMENTATION EXAMPLE MANUAL#

The things I'm going to cover here are just the basic meat-and-potatoes parts of Doxygen that I use on a day to day basis for anything else, please consult the online Doxygen manual it's really quite handy :).ĭoxygen comments come in two flavors: JavaDoc style or Qt style.

Well, just to spite all of us non-believers, here I am with a shiny new tutorial on documenting your source code with Doxygen. So I'm sure a number of you out there were a bit skeptical as to whether or not I'd be able to churn out two Doxygen newsletter articles in a row (I sure didn't think I'd manage :).

Doxygen documentation example