Literal

The <literal> markup can be used to indicate text as plain text that should not be interpreted. This function can be useful to make annotations within the source code of the documentation.

Use Literal within the markups Descriptions, Summaries and Examples.

Example

Normal form:

//!<description> This description contains text that should not be interpreted. As follows. <literal> The <b> bold </b> tag is not interpreted here, but the tags are written to the documentation. </literal> Here follows text again in which the <b> bold </b> marking is interpreted. </description>

Abbreviated form:

//@description This description contains text that should not be interpreted. As follows. @literal The <b> bold </b> tag is not interpreted here, but the tags are written to the documentation.