Specifications

275ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
ASDoc tags
The following table lists the ASDoc tags:
ASDoc tag Description Example
@copy reference
Copies an ASDoc comment from the refer-
enced location. The main description, @param,
and
@return content is copied; other tags are
not copied.
You typically use the @copy tag to copy infor-
mation from a source class or interface not in
the inheritance list of the destination class. If
the source class or interface is in the inherit
-
ance list, use the @inheritDoc tag instead.
You can add content to the ASDoc comment
before the
@copy tag.
Specify the location by using the same syntax
as you do for the
@see tag. For more informa-
tion, see “Using the @see tag” on page 277.
@copy #stop
@copy MovieClip#stop
@default
value
Specifies the default value for a property, style,
or effect. The ASDoc tool automatically creates
a sentence in the following form when it
encounters an
@default tag:
The default value is value.
@default 0xCCCCCC
@eventType package.class.CONSTANT
@eventType String
Use the first form in a comment for an
[Event] metadata tag. It specifies the
constant that defines the value of the
Event.type property of the event object
associated with the event. The ASDoc tool
copies the description of the event constant to
the referencing class.
Use the second form in the comment for the
constant definition. It specifies the name of the
event associated with the constant. If the tag is
omitted, ASDoc cannot copy the constant's
comment to a referencing class.
See “Documenting effects, events, and
styles” on page 273