Specifications

281ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
In this example, the classes must be located at comps\GraphingWidget.as and comps\GraphingWidgetTwo.as,
where comps is a subdirectory of the directory from which you run the
asdoc command. The arguments of the
doc-classes option use dot notation that corresponds to the package name of the class.
If the classes are not in the current directory, use the
source-path option to specify that directory. For example,
if the two input classes are in the directory C:\flex\class_dir\comps, then use the following command-line to
invoke
asdoc:
asdoc -source-path C:\flex\class_dir -doc-classes comps.GraphingWidget
comps.GraphingWidgetTwo
Your application might require library files, represented as SWC files, to compile. In the next example, you use the
-library-path option to specify the directory containing the SWC files:
asdoc -source-path . -doc-classes myComponents.BlueButton -library-path C:\myLibs
You can also specify the source classes by using the doc-sources option. This option causes asdoc to recursively
search directories. The following command line generates output for all classes in the current directory and its
subdirectories:
asdoc -source-path . -doc-sources .
You can specify a namespace as the input by using the doc-namespaces option. The following command line
documents all the classes in the core framework:
asdoc -source-path frameworks
-namespace http://framework frameworks/core-framework-manifest.xml
-doc-namespaces http://framework
Excluding classes
All of the classes specified by the doc-classes, doc-sources, and doc-namespaces options are documented,
with the following exceptions:
• If you specified the class by using the exclude-classes option, the class is not documented.
• If the ASDoc comment for the class contains the @private tag, the class is not documented.
• If the class is found in a SWC, the class is not documented.
In the following example, you generate output for all classes in the current directory and its subdirectories, except
for the two classes comps\PageWidget and comps\ScreenWidget.as:
asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget
Note that the excluded classes are still compiled along with all of the other input classes; only their content in the
output is suppressed.