- Generated by
1.13.0
|
Doxygen
|
The following table gives an overview of the doxygen internal special commands and the version in which they were introduced.
This command is used to prevent endless recursive expansion of aliases. For an alias name the command is inserted after its expansion, and then the expanded string is reparsed, but until the is processed the name is not considered for further alias expansion.
This command has a similar syntax and function as the command \anchor, but is internally used for the @page command in markdown files. Unlike \anchor it has an additional title option that is used as the link text in references to the page.
Internal doxygen command to simulate an end of line, but without advancing the line counter. In this way it is possible to have multiple commands on one line that read till the end of line. This command is internally used by doxygen and for replacement of the ^^ in ALIASES settings. This command sees to it that e.g. warning messages stay correct when a command is replaced internally by multiple commands.
Temporarily also as @_ilinebr (doxygen version 1.8.14) and \_ilinebr (doxygen version 1.8.15 till 1.8.18)
Internal doxygen command to reset the current filename in a documentation block so that doxygen can give a better warning about the original source of a problem when a documentation block is constructed from multiple files.
Internal doxygen command to reset the current line counter in a documentation block so that doxygen can give a better warning about the original source of a problem when a documentation block is constructed from multiple files or blocks from one file.
This command has a similar syntax and function as the command \code, but is internally used for markdown fenced code blocks (i.e. ``` and ~~~ type of blocks) to replace these markers. The \code command cannot be used as in that case the block cannot contain a \endcode as this would terminate the \code block.
Ends a block of text that was started with a \icode command.
This command is to replace the Java documentation commands {@literal .... } and {@code ...}. The text in the blocks will not be interpreted by doxygen in any way. The text in the {@literal will put as is text in the output. The text in the {@code will be replaced by a code block with class JavaDocCode i.e. <code class="JavaDocCode">...</code>.
Ends a block of text that was started with a \iliteral command.
This command has a similar function as the command \verbatim, but is internally used for markdown code blocks (i.e. blocks of text indented with at least 4 extra spaces compared to the previous block) and python unformatted docstrings (i.e. ''' type of blocks) to replace these markers. The \verbatim command cannot be used as in that case the block cannot contain a \endverbatim as this would terminate the \verbatim block.
Internal doxygen command to increase the section level by a given amount. After processing \iraise 1 for instance, a \section s1 will be treated as a \subsection s1. Inserted when processing \include{doc} with the raise option.
Internal doxygen command to suppress evaluation of whitespace to determine the indentation of a comment block. Evaluation will continue as normal when the matching \endiskip command is found. Inserted when processing commands that contain literal text like \startuml, \verbatim, <code> etc.
Internal doxygen command to prefix section labels references for \ref and \link commands. After processing \iprefix "pf_" for instance, a \ref s1 will be treated as if \ref pf_s1 was written. Inserted internally when processing \include{doc} with the prefix option.
Ends a block of text that was started with a \iskip command.
Ends a block of text that was started with a \iverbatim command.
1.13.0