@short and @brief tags

These tags define a short (one liner) description for symbol. Its may be used in member lists and compound tables.

Syntax  

@short <description> <end of line>

Example  

Theses declarations:

/**
@short A generic vector class
This class ...
*/

template <typename T>
class Vector {
};

/**
@short A generic hash table class
This class ...
*/

template <typename T>
class Hash {
};

generate the following class table when used with @insert tag classes_table:

NameDescription
HashA generic hash table class
MGroup
MGroupOrder
Object
VectorA generic vector class

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc