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 > ASDoc tags - Pg. 268

ADOBE FLEX 3 275 Building and Deploying Adobe Flex 3 Applications ASDoc tags The following table lists the ASDoc tags: ASDoc tag @copy reference Description Example @copy #stop Copies an ASDoc comment from the refer- enced location. The main description, @param , @copy MovieClip#stop 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. @default value Specifies the default value for a property, style, @default 0xCCCCCC or effect. The ASDoc tool automatically creates a sentence in the following form when it encounters an @default tag: The default value is value. @eventType package.class.CONSTANT Use the first form in a comment for an @eventType String [Event] metadata tag. It specifies the See "Documenting effects, events, and styles" on page 273 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.