@example Tag

Adds a link into Examples list. A VBdocman comment may contain any number of @example tags.

Syntax

@example reference [label]

It adds a link, with visible text label, that points to the specified reference. This tag should point to a text file containing example code. Warning appears during compilation if reference points to non-existing target. The label is optional. If omitted, instead of it the reference appears as the visible text. Use the label when you want the visible text to be abbreviated or different from the reference. It can contain whitespaces.

See also reference format.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.