@moduledef tag

This tag defines a new module with given name and starts a special group which contains documentation for the new module. An @end moduledef tag must be used to end module documentation.

The special group may contain plain documentation tags and some code documentation tags to describe the module.

Module definitions may be nested.

See also @module tag section.

Syntax  

@moduledef {<Module name>}
<module doc>
@end moduledef

Examples  

Simple module declaration in modules.mkdoc file:

@moduledef {Foo}
@short The Foo module
This modules ....
@end moduledef

A good way to segment project documentation is to use hidden modules:

@moduledef {first_part}
@hidden
@end moduledef

@moduledef {second_part}
@hidden
@end moduledef

Code documentation sections can then be inserted separately in plain documentation for symbols associated with the two modules:

@insert {namespace,header,cxxstruct,class} {+first_part} all_compound_sections

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