flexmojos:asdoc-report

Note:This goal should be used as a Maven report.

Full name:

org.sonatype.flexmojos:flexmojos-maven-plugin:3.5.0:asdoc-report

Description:

Generates documentation for the ActionScript code in the project using the standard Asdoc tool

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.

Required Parameters

Name Type Since Description
reportOutputDirectory File - Specifies the destination directory where javadoc saves the generated HTML files.

Optional Parameters

Name Type Since Description
aggregate boolean 3.5 If true, will treat multi-modules projects as only one project otherwise will generate Asdoc per project
Default value is: false.
compatibilityVersion String - specifies a compatibility version. e.g. compatibility 2.0.1
configFile File - Load a file containing configuration options
description String - The description of the AsDoc report.
Default value is: ASDoc API documentation..
destDir String - The name of the destination directory.
Default value is: asdoc.
docClasses String[] - 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.
docNamespaces Namespace[] - 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.
docSources File[] - 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.
excludeClasses 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
excludeDependencies boolean - Whether all dependencies found by the compiler are documented. If true, the dependencies of the input classes are not documented. The default value is false.
Default value is: false.
footer String - The text that appears at the bottom of the HTML pages in the output documentation.
headlessServer boolean - Sets the compiler when it runs on a server without a display. This is equivalent to using the compiler.headless-server option of the mxmlc or compc compilers. that value determines if the compiler is running on a server without a display.
Default value is: false.
leftFramesetWidth int - An integer that changes the width of the left frameset of the documentation. You can change this size to accommodate the length of your package names. The default value is 210 pixels.
Default value is: 210.
localRepository ArtifactRepository - (no description)
mainTitle String - The text that appears at the top of the HTML pages in the output documentation. The default value is "API Documentation".
Default value is: API Documentation.
name String - The name of the AsDoc report.
Default value is: ASDocs.
namespaces Namespace[] - Specify a URI to associate with a manifest of components for use as MXML elements.
Usage: 
<namespaces>
 <namespace>
  <uri>http://www.adobe.com/2006/mxml</uri>
  <manifest>${basedir}/manifest.xml</manifest>
 </namespace>
</namespaces>

outputDirectory File - The output directory for the generated documentation.
Default value is: ${project.build.directory}/asdoc.
packageDescriptions Map - The descriptions to use when describing a package in the documentation. You can specify more than one package option.
pluginArtifacts List - (no description)
remoteRepositories List - (no description)
sourcePaths File[] - List of path elements that form the roots of ActionScript class hierarchies.
templatesPath File - The path to the ASDoc template directory. The default is the asdoc/templates directory in the ASDoc installation directory. This directory contains all the HTML, CSS, XSL, and image files used for generating the output.
windowTitle String - The text that appears in the browser window in the output documentation. The default value is "API Documentation".
Default value is: API Documentation.

Parameter Details

aggregate:

If true, will treat multi-modules projects as only one project otherwise will generate Asdoc per project
  • Type: boolean
  • Since: 3.5
  • Required: No
  • Expression: ${asdoc.aggregate}
  • Default: false

compatibilityVersion:

specifies a compatibility version. e.g. compatibility 2.0.1
  • Type: java.lang.String
  • Required: No

configFile:

Load a file containing configuration options
  • Type: java.io.File
  • Required: No

description:

The description of the AsDoc report.
  • Type: java.lang.String
  • Required: No
  • Expression: ${description}
  • Default: ASDoc API documentation.

destDir:

The name of the destination directory.
  • Type: java.lang.String
  • Required: No
  • Expression: ${destDir}
  • Default: asdoc

docClasses:

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.
  • Type: java.lang.String[]
  • Required: No

docNamespaces:

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.
  • Type: org.sonatype.flexmojos.utilities.Namespace[]
  • Required: No

docSources:

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.
  • Type: java.io.File[]
  • Required: No

excludeClasses:

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
  • Type: java.lang.String[]
  • Required: No

excludeDependencies:

Whether all dependencies found by the compiler are documented. If true, the dependencies of the input classes are not documented. The default value is false.
  • Type: boolean
  • Required: No
  • Default: false

footer:

The text that appears at the bottom of the HTML pages in the output documentation.
  • Type: java.lang.String
  • Required: No

headlessServer:

Sets the compiler when it runs on a server without a display. This is equivalent to using the compiler.headless-server option of the mxmlc or compc compilers. that value determines if the compiler is running on a server without a display.
  • Type: boolean
  • Required: No
  • Default: false

leftFramesetWidth:

An integer that changes the width of the left frameset of the documentation. You can change this size to accommodate the length of your package names. The default value is 210 pixels.
  • Type: int
  • Required: No
  • Default: 210

localRepository:

(no description)
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

mainTitle:

The text that appears at the top of the HTML pages in the output documentation. The default value is "API Documentation".
  • Type: java.lang.String
  • Required: No
  • Default: API Documentation

name:

The name of the AsDoc report.
  • Type: java.lang.String
  • Required: No
  • Expression: ${name}
  • Default: ASDocs

namespaces:

Specify a URI to associate with a manifest of components for use as MXML elements.
Usage: 
<namespaces>
 <namespace>
  <uri>http://www.adobe.com/2006/mxml</uri>
  <manifest>${basedir}/manifest.xml</manifest>
 </namespace>
</namespaces>
  • Type: org.sonatype.flexmojos.utilities.Namespace[]
  • Required: No

outputDirectory:

The output directory for the generated documentation.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/asdoc

packageDescriptions:

The descriptions to use when describing a package in the documentation. You can specify more than one package option.
  • Type: java.util.Map
  • Required: No

pluginArtifacts:

(no description)
  • Type: java.util.List
  • Required: No
  • Expression: ${plugin.artifacts}

remoteRepositories:

(no description)
  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

reportOutputDirectory:

Specifies the destination directory where javadoc saves the generated HTML files.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}/asdoc

sourcePaths:

List of path elements that form the roots of ActionScript class hierarchies.
  • Type: java.io.File[]
  • Required: No

templatesPath:

The path to the ASDoc template directory. The default is the asdoc/templates directory in the ASDoc installation directory. This directory contains all the HTML, CSS, XSL, and image files used for generating the output.
  • Type: java.io.File
  • Required: No

windowTitle:

The text that appears in the browser window in the output documentation. The default value is "API Documentation".
  • Type: java.lang.String
  • Required: No
  • Default: API Documentation