flex:asdoc

Full name:

org.servebox.flex:flex-plugin:2.3.2:asdoc

Description:

Generate documentation at the ASDoc format. You should add a zip file containing an ASDoc template (including asDocHelper executable) to your project dependencies, or set a directory containing the template using the template property.

To document a package, create a package-info.txt in your package directory (i.e.src/main/flex/org/myproject/mypackage/package-info.txt, containing the package description).

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Optional Parameters

Name Type Since Description
actionScriptEncoding String - The encoding of source files.
Default value is: utf-8.
archiveFiles ArrayList - Files to be archived into the swc.
asDocTemplateDependency ASDocTemplateDependency - The ZIP dependency to set as the template file. This parameter is ignored if templateDirectory is defined.
classifier String - Artifact classifier.
componentManifests ArrayList - The manifest to use for compilation.
defineDirectives ArrayList - A list of "define" directives, allowing conditional compilation.
flexConfigurationFile File - The location of the flex configuration file.
footer String - The text appearing in the footer of the documentation pages.
Default value is: ${project.name} API Documentation - Generated using Adobe ASDoc / Maven Flex Plugin.
leftFramesetWidth int - The with of the left frameset of the documentation pages.
Default value is: 210.
localRepository ArtifactRepository - (no description)
localesDirectory File - The directory in which locale resides such as en_US, fr_FR etc...
Default value is: ${project.basedir}/src/locales/flex.
mainTitle String - The title of the documentation.
Default value is: API Documentation : ${project.name}.
outputDirectory File - The directory in which the compiled artifact should be placed.
Default value is: ${project.build.directory}.
remoteRepositories List - (no description)
reportOutputDirectory File - The directory in which the generated files should be placed.
Default value is: ${project.reporting.outputDirectory}/asapidocs.
resourcesDirectory File - The directory in which resources reside such as CSS stylesheets, images, etc.
Default value is: ${project.basedir}/src/main/resources.
sourceDirectory File - The directory in which MXML and AS sources resides.
Default value is: ${project.basedir}/src/main/flex.
styleSheets ArrayList - StyleSheet to be archived into the swc.
templateDirectory File - The directory in which the template files can be found.
windowTitle String - The title of the documentation page (corresponding to the XHTML tag).
Default value is: ${project.name} API Documentation.

Parameter Details

actionScriptEncoding :

The encoding of source files.
  • Type: java.lang.String
  • Required: No
  • Expression: ${flex.compiler.actionScriptEncoding}
  • Default: utf-8

archiveFiles :

Files to be archived into the swc.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${flex.compiler.archiveFiles}

asDocTemplateDependency :

The ZIP dependency to set as the template file. This parameter is ignored if templateDirectory is defined.
  • Type: org.servebox.flex.mojo.ASDocTemplateDependency
  • Required: No
  • Expression: ${flex.asdoc.asDocTemplateDependency}

classifier :

Artifact classifier.
  • Type: java.lang.String
  • Required: No

componentManifests :

The manifest to use for compilation.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${flex.compiler.componentManifests}

defineDirectives :

A list of "define" directives, allowing conditional compilation.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${flex.compiler.defineDirectives}

flexConfigurationFile :

The location of the flex configuration file.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.compiler.configurationFile}

footer :

The text appearing in the footer of the documentation pages.
  • Type: java.lang.String
  • Required: No
  • Expression: ${flex.asdoc.footer}
  • Default: ${project.name} API Documentation - Generated using Adobe ASDoc / Maven Flex Plugin

leftFramesetWidth :

The with of the left frameset of the documentation pages.
  • Type: int
  • Required: No
  • Expression: ${flex.asdoc.leftFramesetWidth}
  • Default: 210

localRepository :

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

localesDirectory :

The directory in which locale resides such as en_US, fr_FR etc...
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}/src/locales/flex

mainTitle :

The title of the documentation.
  • Type: java.lang.String
  • Required: No
  • Expression: ${flex.asdoc.mainTitle}
  • Default: API Documentation : ${project.name}

outputDirectory :

The directory in which the compiled artifact should be placed.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.compiler.outputDirectory}
  • Default: ${project.build.directory}

remoteRepositories :

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

reportOutputDirectory :

The directory in which the generated files should be placed.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.asdoc.outputDirectory}
  • Default: ${project.reporting.outputDirectory}/asapidocs

resourcesDirectory :

The directory in which resources reside such as CSS stylesheets, images, etc.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.compiler.resources}
  • Default: ${project.basedir}/src/main/resources

sourceDirectory :

The directory in which MXML and AS sources resides.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.compiler.source}
  • Default: ${project.basedir}/src/main/flex

styleSheets :

StyleSheet to be archived into the swc.
  • Type: java.util.ArrayList
  • Required: No
  • Expression: ${flex.compiler.styleSheets}

templateDirectory :

The directory in which the template files can be found.
  • Type: java.io.File
  • Required: No
  • Expression: ${flex.asdoc.templateDirectory}

windowTitle :

The title of the documentation page (corresponding to the XHTML tag).
  • Type: java.lang.String
  • Required: No
  • Expression: ${flex.asdoc.windowTitle}
  • Default: ${project.name} API Documentation