C Sharp and Doxygen

From Schmid.wiki
Jump to: navigation, search

Contents

doxygen.cfg

Ignore inlineness, only look at *.cs files:

INLINE_INFO   = NO
FILE_PATTERNS = *.cs

Groups

Modules

Groups of classes are called Modules.

Modules are made using the @defgroup and @ingroup commands.

Generic example:

/** @defgroup things Things that do stuff
 * Things that do stuff are very important.
 */
/** Short description of Stuff; it is short.
 * More detailed description here.
 * @ingroup things
 */
class Stuff {
}

Regions

C# regions are easily made into Doxygen member groups:

class Stuff {
#region /// @name Singleton

    public int Something = 0;
    public int SomethingElse = 2;

#endregion
}
Personal tools