Attaching comment block to a specific typedef ( typedef )
The typedef command is used to explicitly link a documentation comment block to the specified typedef.
Syntax
/**
\typedef TypeDef
Normal way of documenting goes here ....
*/
|
Output
The typedef command does not produce any output of its own, but secures that the comment block as a whole is used to produce the documentation of the specified class.
About putting the documentation in separate files
This command is used for documenting an entity away from it's definition in the code. See SeparateDocs for some examples.
The commands for making separate documentation are:
\class, \def, \enum, (\file), \fn, \namespace, \struct, \typedef, \union \var
Qualify with scope (class, namepace) if inside a scope like this: