mrdocs::doc
Doc‐comment enums and helpers that describe admonition kinds.
Types
Name |
Description |
A block for side‐notes like tips, warnings, notes |
|
A piece of block content |
|
Base class for providing variant discriminator functions. |
|
A composite block that stores a sequence of child blocks. |
|
The brief description |
|
Preformatted source code. |
|
Inline code (monospaced) used for short snippets within text. |
|
Documentation copied from another symbol. |
|
A list of terms paired with definitions. |
|
An item in a definition list |
|
Emphasized text (typically rendered in italics). |
|
Text defining the content of a footnote reference. |
|
A reference to a symbol. |
|
A manually specified section heading. |
|
Highlighted text span used to call out important words. |
|
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 |
|
A block of LaTeX math |
|
An inline LaTeX math expression |
|
A sequence of text nodes. |
|
Documentation for a function parameter |
|
Text describing conditions guaranteed on successful exit. |
|
Text describing required conditions before entry. |
|
A quoted block of text. |
|
A reference to a symbol. |
|
Documentation for a function return type |
|
A |
|
A line break that may render as a space |
|
Strikethrough span to show removed or deprecated text. |
|
Strong emphasis span (typically rendered in bold). |
|
Subscript text fragment (lowered baseline). |
|
Superscript text fragment (raised baseline). |
|
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. |
|
A horizontal thematic break separating sections. |
|
Documentation for a function exception clause |
Enums
Name |
Description |
An admonishment style. |
|
Enumerates the different kinds of DocComment blocks. |
|
Enumerates the different kinds of inline nodes. |
|
Parameter pass direction. |
|
Which parts of the documentation to copy. |
Functions
Name |
Description |
|
|
Return true if the given block kind represents a command block. |
|
Determine if the inline is empty |
|
|
|
|
|
|
|
|
|
Traverse a list of inlines. |
|
|
|
|
|
Equality delegates to the three‐way comparison. |
|
Three‐way comparison operators |
Using Declarations
Name |
Description |
Three‐way comparison for any described type. |
|
Equality for any described type. |
Created with MrDocs