6.9 Putting Documentation after Members
For example, to document the members of a struct
, union
, or enum
, and to
put the documentation for those members inside the compound, it might be
desirable to place the documentation block after the member. Do this by putting
an additional <
marker in the comment block.
For example:
int var; ///< Brief description after the member
Note: These blocks have the same structure and meaning as special comment
blocks. The <
indicates that the member to be documented is located before
the comment.
Note: Only be used these blocks to document members and parameters. Do not
use them to document files, classes, unions, structs, groups, namespace, or
enums themselves. Furthermore, structural commands (such as @struct
) are
ignored inside these comment blocks.