Specifications

CHAPTER 13
276
@example exampleText
Applies style properties, generates a heading,
and puts the code example in the correct loca
-
tion. Enclose the code in <listing
version="3.0"></listing>
tags.
Whitespace formatting is preserved and the
code is displayed in a gray, horizontally
scrolling box.
@example The following code
sets the volume level for your
sound:
<listing version="3.0">
var mySound:Sound = new
Sound();
mySound.setVolume(VOL_HIGH);
</listing>
@exampleText string
Use this tag in an ASDoc comment in an
external example file that is referenced by the
@example tag. The ASDoc comment must
precede the first line of the example, or follow
the last line of the example.
External example files support one comment
before and one comment after example code.
/**
* This text does not appear
* in the output.
* @exampleText But this does.
*/
@inheritDoc
Use this tag in the comment of an overridden
method or property. It copies the comment
from the superclass into the subclass, or from
an interface implemented by the subclass.
The main ASDoc comment, @param, and
@return content are copied; other tags are
not. You can add content to the comment
before the
@inheritDoc tag.
When you include this tag, ASdoc uses the
following search order:
1. Interfaces implemented by the current class
(in no particular order) and all of their base-
interfaces.
2. Immediate superclass of current class.
3. Interfaces of immediate superclass and all of
their base-interfaces.
4. Repeat steps 2 and 3 until the Object class is
reached.
You can also use the @copy tag, but the @copy
tag is for copying information from a source
class or interface that is not in the inheritance
chain of the subclass.
@inheritDoc
ASDoc tag Description Example