Specifications

271ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
* @private
*/
public function set html(value:Boolean):void {};
The following rules define how ASDoc handles properties defined by setter and getter methods:
• If you precede a setter or getter method with an ASDoc comment, the comment is included in the output.
• If you define both a setter and a getter method, only a single ASDoc comment is needed – either before the
setter or before the getter.
• If you define a setter method and a getter method, insert a single ASDoc comment before the getter, and mark
the setter as
@private.
• You do not have to define the setter method and getter method in any particular order, and they do not have
to be consecutive in the source-code file.
• If you define just a getter method, the property is marked as read-only.
• If you define just a setter method, the property is marked as write-only.
• If you define both a public setter and public getter method in a class, and you want to hide them by using the
@private tag, they both must be marked @private.
• If you have only one public setter or getter method in a class, and it is marked @private, ASDoc applies
normal
@private rules and omits it from the output.
• A subclass always inherits its visible superclass setter and getter method definitions.
Documenting methods
The ASDoc tool automatically includes all public and protected methods in its output. Place the ASDoc comment
for a public or protected method just before the
function declaration, as the following example shows:
/**
* This is the typical format of a simple multiline documentation comment
* for the myMethod() method.
*
* <p>This is the second paragraph of the main description
* of the <code>myMethod</code> method.
* Notice that you do not use the paragraph tag in the
* first paragraph of the description.</p>
*
* @param param1 Describe param1 here.
* @param param2 Describe param2 here.
*
* @return A value of <code>true</code> means this;
* <code>false</code> means that.
*