APIDOC Namespace Reference

API Organizational

Summary

Container for all other tags.

Syntax

<API id="..." version="...">
    . . .
</API>
NameTypeDescription
idstringIdentifier for the API.
versionnumberThe APIDOC version expected by the contained tags.  Currently this attribute is ignored.

Description

The API tag is the top level container for all other tags.  It is analogous to the HTML tag in used in HTML documents.  Unlike in HTML, if tags appear outside of the API tag, the file will fail to parse.

Notes

API is the top level tag, it contains all other tags.

See Also

Groups [ Organizational ]
Documents [ APIDOC ]

This page was generated by APIDOC