Specifications

CHAPTER 13
272
* @see someOtherMethod
*/
public function myMethod(param1:String, param2:Number):Boolean {}
If the method takes an argument, include an @param tag for each argument to describe the argument. The order
of the
@param tags in the ASDoc comment should match the order of the arguments to the method. The @param
tag has the following syntax:
@param paramName description
Where paramName is the name of the argument and description is a description of the argument.
If the method returns a value, use the
@return tag to describe the return value. The @return tag has the following
syntax:
@return description
Where description describes the return value.
Documenting metadata
Flex uses metadata tags to define elements of a component. ASDoc recognizes these metadata tags and treats them
as if there were properties or method definitions. The metadata tags recognized by ASDoc include:
• [Bindable]
• [DefaultProperty]
• [Effect]
• [Event]
• [Style]
For more information on these metadata tags, see “Metadata Tags in Custom Components” on page 33 in Creating
and Extending Adobe Flex 3 Components.
Documenting bindable properties
A bindable property is any property that can be used as the source of a data binding expression. To mark a
property as bindable, you insert the
[Bindable] metadata tag before the property definition, or before the class
definition to make all properties defined within the class bindable.
When a property is defined as bindable, ASDoc automatically adds the following line to the output for the
property:
This property can be used as the source for data binding.
For more information on the [Bindable] metadata tag, see “Metadata Tags in Custom Components” on page 33
in Creating and Extending Adobe Flex 3 Components.