mrdocs::doc
Types
Name |
Description |
A block for side‐notes like tips, warnings, notes |
|
A piece of block content |
|
Base class for providing variant discriminator functions. |
|
The brief description |
|
Preformatted source code. |
|
A piece of styled text. |
|
Documentation copied from another symbol. |
|
An item in a definition list |
|
A piece of styled text. |
|
Preformatted source code. |
|
A reference to a symbol. |
|
A manually specified section heading. |
|
A piece of highlighted text. |
|
An image. |
|
A Node containing a string of text. |
|
Base class for providing variant discriminator functions. |
|
An internal node in the inline element tree |
|
A leaf node that stores a string of text. |
|
A hard line break that renders as "" |
|
A hyperlink. |
|
A list of list items |
|
An item in a list |
|
A block of LaTeX math |
|
An inline LaTeX math expression |
|
A sequence of text nodes. |
|
Documentation for a function parameter |
|
A list of list items |
|
A reference to a symbol. |
|
Documentation for a function return type |
|
A |
|
A line break that may render as space |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
A piece of styled text. |
|
Documentation for a template parameter |
|
A table block |
|
A cell in a table |
|
An item in a list |
|
A Node containing a string of text. |
|
The brief description |
|
Documentation for a function parameter |
Enums
Name |
Description |
An admonishment style. |
|
Parameter pass direction. |
|
Which parts of the documentation to copy. |
Functions
Name |
Description |
|
|
Determine if the inline is empty |
|
|
|
|
|
|
|
|
|
Traverse a list of inlines. |
|
|
|
|
|
Equality operators |
|
Three‐way comparison operators |
Created with MrDocs