@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 [link]
@short <description> <end of line>
Example [link]
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:
Name | Description |
---|---|
Hash | A generic hash table class |
MGroup | |
MGroupOrder | |
Object | |
Vector | A generic vector class |