The following list is a table of ASDoc tags
ASDoc tag |
Description |
Example |
---|---|---|
@copy reference |
Copies an ASDoc comment from the referenced location. The main description, @param, and @return content is copied; other tags are not copied. |
@copy #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: |
@default 0xCCCCCC |
@eventType package.class.CONSTANT |
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. |
|
@example exampleTex |
Applies style properties, generates a heading, and puts the code example in the correct location. Enclose the code in <listing version="3.0"></listing> tags. |
@example The following code sets the volume level for your sound: |
@exampleText strin |
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. |
/** |
@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. |
@inheritDoc |
@internal text |
Hides the text attached to the tag in the generated 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. |
@private |
@return description |
Adds a Returns section to a method description with the specified text. ASDoc automatically 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. |
@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. |