APIDOC Namespace Reference

TYPE Organizational

Summary

Indicates the type of an ENTRY.

Syntax

<TYPE value="..."/>
NameTypeDescription
valuestringType of the entry.

Description

The value attribute should be used to describe the ENTRYs type.  For example, documentation on a C based API may use 'Macro', 'Data Structure' and 'Function' as types, while this document uses 'Organizational', 'Formatting', and 'Other' as type names.

When a TYPE tag is encountered, a new GROUP is created (if it doesn't already exist), and the ENTRY which contains the TYPE tag is added to that group.  In addition, the new GROUP is automatically added to the 'Groups' portion of 'See Also' for that ENTRY.

Notes

TYPE can only be contained by an ENTRY tag.

See Also

Groups [ Formatting | Organizational | Other ]
Entries [ ENTRY | GROUP ]

This page was generated by APIDOC