APIDOC Namespace Reference

EXAMPLE Organizational

Summary

An example usage the ENTRY.

Syntax

<EXAMPLE desc="...">
    . . .
</EXAMPLE>
NameTypeDescription
descstringShort description of what the example shows.

Description

Contains a "real world" example of the ENTRY being used. As with the SYNTAX tag text inside EXAMPLE tags will be rendered in a mono-space font, and leading spaces are significant. The desc attribute can be used to provide a short caption for the example.

Example

This an example of the EXAMPLE tag
<EXAMPLE desc="This an example of the EXAMPLE tag">
   Place sample code to be rendered in a mono-space font here.
</EXAMPLE>

Notes

EXAMPLE can only be contained by an ENTRY tag.

Formatting tags cannot be used inside an EXAMPLE tag.

See Also

Groups [ Formatting | Organizational ]
Entries [ ENTRY | SYNTAX ]

This page was generated by APIDOC