Specifications

CHAPTER 13
282
If you set the exclude-dependencies option to true, dependent classes found when compiling classes are not
documented. The default value is
false, which means any classes that would normally be compiled along with
the specified classes are documented.
For example, you specify class A by using the doc-classes option. If class A imports class B, both class A and
class B are documented.
Options to the asdoc command
The options to the asdoc command work the same way that mxmlc and compc options work. For more infor-
mation on mxmlc and comp, see “Using the Flex Compilers” on page 125.
The following table lists the options to the asdoc command:
Option Description
-doc-classes path-element [...]
A list of classes to document. These classes must be in the source path. This is the default
option.
This option works the same way as does the -include-classes option for the compc
component compiler. For more information, see
“Using compc, the component compiler”
on page 161.
-doc-namespaces uri manifest
A list of URIs whose classes should be documented. The classes must be in the source path.
You must include a URI and the location of the manifest file that defines the contents of this
namespace.
This option works the same way as does the -include-namespaces option for the
compc component compiler. For more information, see “Using compc, the component
compiler” on page 161.
-doc-sources path-element [...]
A list of files that should be documented. If a directory name is in the list, it is recursively
searched.
This option works the same way as does the -include-sources option for the compc
component compiler. For more information, see
“Using compc, the component compiler”
on page 161.
-exclude-classes string
A list of classes that should not be documented. You must specify individual class names.
Alternatively, if the ASDoc comment for the class contains the
@private tag, is not docu-
mented.
-exclude-dependencies true|false
Whether all dependencies found by the compiler are documented. If true, the dependen-
cies of the input classes are not documented.
The default value is false.
-footer string
The text that appears at the bottom of the HTML pages in the output documentation.