Specifications

CHAPTER 13
274
* </table>
*
* @eventType buttonDown
*/
public static const BUTTON_DOWN:String = "buttonDown"
The ASDoc tool does several things for this event:
• In the output for the mx.controls.Button class, ASDoc creates a link to the event class that is specified by the
type argument of the [Event] metadata tag.
• ASDoc copies the description of the mx.events.FlexEvent.BUTTON_DOWN constant to the description of the
buttonDown event in the Button class.
For a complete example, see the mx.controls.Button and mx.events.FlexEvent classes.
For more information on the
[Effect], [Event], and [Style] metadata tags, see “Metadata Tags in Custom
Components” on page 33 in Creating and Extending Adobe Flex 3 Components.
Documenting MXML files
You can use the ASDoc tool with MXML files as well as ActionScript files. All ActionScript entities defined in an
<mx:Script> block, such as properties and methods, appear in the output. Items defined in MXML tags do not
appear in the ASDoc output.
Because the format of an ASDoc comment uses ActionScript syntax, you can only insert an ASDoc comment in
an
<mx:Script> block of an MXML file.
MXML files correspond to ActionScript classes where the superclass corresponds to the first tag in the MXML
file. For an application file, that tag is the
<mx:Application> tag and therefore an MXML application file appears
in the ASDoc output as a subclass of the Application class.