APIDOC Namespace Reference

PARAM Organizational

Summary

Description for a parameter used by the ENTRY

Syntax

<PARAM name="..." type="...">
    . . .
</PARAM>
NameTypeDescription
namestringThe name of the parameter.
typestringThe data type of the parameter.

Description

Used to describe a parameter used by the ENTRY.  PARAM tags can only be contained inside SYNTAX tags.  Multiple PARAM tags can appear in a SYNTAX tag (typically one for each parameter).  PARAM tags will be displayed in the order they appear.

Example

<PARAM name="name" type="string">
   The name of the parameter.
</PARAM>
<PARAM name="type" type="string">
   The data type of the parameter.
</PARAM>

Notes

PARAM can only be contained by a SYNTAX tag.

See Also

Groups [ Organizational ]
Entries [ ENTRY | SYNTAX ]

This page was generated by APIDOC