This would be a detailed description of class Base. Note that private
members are not displayed by these templates.
Note also that class description comments can now come both before and
after the class declaration, and, with the -h option, comments can include
This is a custom comment type. You can now create as many comment types as you like for precise output control.
|Base (int arg1)||: Class Constructor|
|int||public1 ()||: A Public member function.|
|float||public2 ( float arg1, float arg2)||: A member function for class base|
|class||NestedClass||: A Nested class|
|float||protected1||: A protected member|
|int||protected2, *protected3||: Variable lists are supported|
|float||protected4 ( double arg1 )|
|friend iostream &||operator<< (iostream &)|
You can include a detailed description of this function and its
Note that, with the autolink feature, references to
Base, Derived1, or Derived2 become links.
float public2( float arg1, float arg2)
Parameter Description arg1 Description of arg1 arg2 Description of arg2
The tabulted parameter list above illustrates the use of custom comments together with plugin filters. This is more documentation from the member function definition that can be merged with the class documentation using the -m switch.