mrdocs::DocComment
A processed documentation comment attached to a declaration.
Description
A complete documentation comment document consists of a sequence of text blocks. Blocks are the top‐level structural units that might contain other blocks or inline elements. These are analogous to markdown blocks.
Inline elements (text, emphasis, links, code spans, etc.) live inside certain block types, like paragraphs or headings. Inlines can contain other inlines (e.g., emphasis contains text, link contains text), but they cannot directly contain blocks.
Some blocks contain metadata about the symbol being documented, such as parameters and return values. These blocks are parsed as usual, but are stored separately in the DocComment structure.
Each block in the document might contain:
-
No other blocks (leaf blocks)
-
Other blocks (container blocks: e.g. lists)
When they contain no other blocks, they might be:
-
Inlines only (e.g. paragraphs)
-
No inlines (e.g. horizontal rule)
Inline content elements contain other inlines but cannot contain blocks.
Member Functions
Name |
Description |
|
Constructors |
Append blocks from another DocComment to this. |
|
Return true if this is empty |
|
Equality operator |
|
Inequality operator |
|
Three‐way comparison operator |
Data Members
Name |
Description |
The list of text blocks. |
|
A brief description of the symbol. |
|
The list of exceptions. |
|
The list of parameters. |
|
The list of postconditions. |
|
The list of preconditions. |
|
The list of "related" references. |
|
The list of "relates" references. |
|
The list of return type descriptions. |
|
The list of "see also" references. |
|
The list of template parameters. |
Created with MrDocs