APIDOC Namespace Reference

SYNTAX Organizational

Summary

Syntax for using the ENTRY.

Syntax

<SYNTAX>
     . . .
</SYNTAX>

Description

Shows the user an abstract use of the ENTRY.  PARAM tags can be contained by the SYNTAX tag to further illustrate parameters.  Text inside SYNTAX tags will be rendered in a mono-space font using the HTML PRE tag.  Leading spaces in the text contained in a SYNTAX tag are converted to &nbsp; entities.  Use the EXAMPLE tag for concrete examples.

Notes

SYNTAX can only be contained by an ENTRY tag.

Formatting tags cannot be used inside an SYNTAX tag.

See Also

Groups [ Formatting | Organizational ]
Entries [ ENTRY | EXAMPLE | PARAM ]

This page was generated by APIDOC