|
|
Summary
An external source with more information about the API.
|
Syntax
<EXTERNALREF name="..." value="..."/>
| Name | Type | Description |
|---|
name | string | A text description of the reference.
|
value | URL | The URL for the reference.
|
|
Description
EXTERNALREFs will be added to the 'See Also' portion of
an ENTRY. If an EXTERNALREF appears as a child of the
API tag, and the value of the URL contains the characters
'{e}', the reference will be attached to every entry, and the
ENTRYs id will be substituted in for '{e}'. If '{e}' does
not appear in the value attribute, APIDOC assumes that this
EXTERNALREF applies to the API as a whole, and only lists it in
the table of contents.
If an EXTERNALREF appears as a child
of an ENTRY tag, it will only appear in that ENTRYs
'See Also' section.
Multiple EXTERNALREF tags can appear as children of both
API and ENTRY tags.
|
Notes
TYPE can only be contained by the API and ENTRY
tags.
|
See Also
|