APIDOC Namespace Reference

S Formatting

Summary

Creates an inline link to an EXTERNALREF or GROUP.

Syntax

<S>. . .</S>

Description

If the text wrapped in an S tag is a valid GROUP (including a GROUP implied by a TYPE or DEPRECATED tag) a link to the referenced group will be created in addition to the text.  If instead, the text matches a valid EXTERNALREF tag, a link to the external reference will be created.

In both cases, an appropriate entry is added to the ENTRYs 'See Also' section.

Notes

If the text contained by an S tag does not match any GROUP or EXTERNALREF, the parse will fail.

Formatting tags cannot be used in SYNTAX or EXAMPLE tags (but they can be used in PARAM tags.)

See Also

Groups [ Formatting ]
Entries [ DEPRECATED | ENTRY | EXAMPLE | EXTERNALREF | GROUP | PARAM | SYNTAX | TYPE ]

This page was generated by APIDOC