Specifications
267ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
For example, to exclude documentation on the click event in the MyButton subclass of the Button class, insert
the following
[Exclude] metadata tag in the MyButton.as file:
[Exclude(name="click", kind="event")]
Using HTML tags
You must write the text of an ASDoc comment in XHTML-compliant HTML. You can use selected HTML entities
and HTML tags to define paragraphs, format text, create lists, and add anchors. For a list of the supported HTML
tags, see “Summary of commonly used HTML elements” on page 279.
The following example comment contains HTML tags to format the output:
/**
* This is the typical format of a simple multiline 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.
*
* @see someOtherMethod
*/
public function myMethod(param1:String, param2:Number):Boolean {}
Using special characters
The ASDoc tool might fail if your source files contain non-UTF-8 characters such as curly quotes. If it does fail,
the error messages it displays should refer to a line number in the interim XML file that was created for that class.
That can help you track down the location of the special character.
ASDoc passes all HTML tags and tag entities in a comment to the output. Therefore, if you want to use special
characters in a comment, you must enter them using HTML code equivalents. For example, to use a less-than (<)
or greater-than (>) symbols in a comment, use
< and >. To use the at-sign (@) in a comment, use &64;.
Otherwise, these characters will be interpreted as literal HTML characters in the output.
For a list of common HTML tags and their entity equivalents, see “Summary of commonly used HTML elements”
on page 279.