APIDOC Namespace Reference

ENTRY Organizational

Summary

An entry point in the API.

Syntax

<ENTRY id="...">
    . . .
</ENTRY>
NameTypeDescription
idstringIdentifier for the entry point.

Description

The ENTRY tag declares an API entry point you wish to document. It serves as the container for most other Organizational tags. Entries can be referenced in SEEALSO tags.  If text appearing in a C tag is also an ENTRY, a link will be created.

Notes

ENTRY can only be contained by the API tag.

See Also

Groups [ Organizational ]
Entries [ API | C | SEEALSO ]

This page was generated by APIDOC