APIDOC Namespace Reference

C Formatting

Summary

Marks text as code.

Syntax

<C>foo</C>

Description

Any text contained in a C tag will appear in a mono-space font, rendered using the HTML CODE tag.  In addition, if the text is an ENTRYid (but not the current ENTRY), a link will be created to the ENTRY in the text, and a SEEALSO tag will be generated.

For example, all of the links in this body of text were generated by wrapping the plain text in a C tag.  APIDOC checks to see of the contained text is a valid ENTRY, and if so, assumes that's what you were talking about.  If the contained text is not a valid ENTRY, or it is the current entry, the text is rendered in a HTML CODE container, and no links are generated.

Notes

Formatting tags cannot be used in SYNTAX or EXAMPLE tags (but they can be used in PARAM tags.)

See Also

Groups [ Formatting ]
Documents [ APIDOC ]
Entries [ ENTRY | EXAMPLE | PARAM | SEEALSO | SYNTAX ]

This page was generated by APIDOC