Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

Share this Page URL
Help

Chapter 13: Using ASDoc > Documenting ActionScript elements - Pg. 262

ADOBE FLEX 3 269 Building and Deploying Adobe Flex 3 Applications Documenting ActionScript elements You can add ASDoc comments to class, property, method, and metadata elements to document ActionScript classes. For more information on documenting MXML files, see "Documenting MXML files" on page 274. Documenting classes The ASDoc tool automatically includes all public classes in its output. Place the ASDoc comment for a class just before the class declaration, as the following example shows: /** * The MyButton control is a commonly used * MyButton controls look like they can be * They can have a text label, an icon, or */ public class MyButton extends UIComponent } rectangular button. pressed. both on their face. { This comment appears at the top of the HTML page for the associated class. To configure ASDoc to omit the class from the output, insert an @private tag anywhere in the ASDoc comment, as the following example shows: /** * @private * The MyHiddenButton control is for internal use only. */ public class MyHiddenButton extends UIComponent { } Documenting properties The ASDoc tool automatically includes all public and protected properties in its output. You can document properties that are defined as variables or defined as setter and getter methods. Documenting properties defined as variables Place the ASDoc comment for a public or protected property that is defined as a variable just before the var decla- ration, as the following example shows: /** *The default label for MyButton. * *@default null