Specifications

277ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
Using the @see tag
The @see tag lets you create cross-references to elements within a class; to elements in other classes in the same
package; and to other packages. You can also cross-reference URLs outside of ASDoc. The
@see tag has the
following syntax:
@see reference [displayText]
where reference specifies the destination of the link, and displayText optionally specifies the link text. The location
of the destination of the
@see tag is determined by the prefix to the reference attribute:
• # ASDoc looks in the same class for the link destination.
• ClassName ASDoc looks in a class in the same package for the link destination.
@internal text
Hides the text attached to the tag in the gener-
ated output. The hidden text can be used for
internal comments.
@internal Please do not
publicize the undocumented use
of the third parameter in this
method.
@param paramName description
Adds a descriptive comment to a method
parameter. The
paramName argument must
match a parameter definition in the method
signature.
@param fileName The name of
the file to load.
@private
Exclude the element from the generated
output.
To omit an entire class, put the @private tag
in the ASDoc comment for the class; to omit a
single class element, put the
@private tag in
the ASDoc comment for the element.
@private
@return description
Adds a Returns section to a method descrip-
tion with the specified text. ASDoc automati-
cally determines the data type of the return
value.
@return The translated
message.
@see reference [displayText]
Adds a See Also heading with a link to a class
element. For more information, see
“Using the
@see tag” on page 277.
Do not include HTML formatting characters in
the arguments to the
@see tag.
@see flash.display.MovieClip
@throws package.class.className
description
Documents an error that a method can throw.
@throws SecurityError Local
untrusted SWFs may not
communicate with the Internet.
ASDoc tag Description Example