|
|
Summary
Includes an ENTRY in a group.
|
Syntax
<GROUP name="..." [value="..."]/>
| Name | Type | Description |
|---|
name | string | The name of the group.
|
value | ENTRY id | The id of the ENTRY to add to the group. Optional
(and ignored) if the GROUP tag appears as a child of
an ENTRY tag, in which case the id of the containing
ENTRY is used.
|
|
Description
For each unique GROUP name appearing in the API, a sub-heading
will appear in the Table of Contents, listing each member of the
GROUP. Multiple GROUP tags can appear as children of
the API tag. The GROUP tag can appear as a child of
either the API tag, or an ENTRY tag. When a GROUP
is parented directly by the API tag, both name and
value attributes must be specified. When a GROUP tag
is parented by an ENTRY tag, the id of the containing
ENTRY is used in place of the value attribute.
Marking an item as DEPRECATED automatically makes it a member
of the group named 'Deprecated'. Using the TYPE tag
in an ENTRY automatically makes it a member of
a group of the same name as the TYPE.
|
Notes
GROUP can only be contained by the API and ENTRY
tags.
|
See Also
|