flex2:asdoc

API Document generator for Actionscript 3 code.

Mojo Attributes :

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

Required Parameters

Name Type Description
asdocTemplates File The location of the asdoc templates to be used in generating documentation Default value is ${flex.home}/asdoc/templates.
description String Report description Default value is ASDoc Actionscript API Documentation.
finalName String Name of the generated compiled binary file.
flexHome File The directory in which Flex (command-line or builder) is installed.
name String Report name Default value is ASDocs.
reportOutputDirectory File Specifies the destination directory where javadoc saves the generated HTML files.

Optional Parameters

Name Type Description
classifier String Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.
destDir String The name of the destination directory. Default value is apidocs.
extraParameters Parameter[] No description.
flexConfig File The location of the flex configuration file.
javaOpts String[] These are additional JVM options used when invoking the Flex compiler
projectHelper MavenProjectHelper No description.
siteRenderer Renderer Generates the site report
source File Location of the flex sources.

Parameter Details

asdocTemplates

The location of the asdoc templates to be used in generating documentation

  • Type : java.io.File
  • Required : Yes
  • Expression : ${asdoc.templates}
  • Default : ${flex.home}/asdoc/templates

classifier

Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.

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

description

Report description

  • Type : java.lang.String
  • Required : Yes
  • Default : ASDoc Actionscript API Documentation

destDir

The name of the destination directory.

  • Type : java.lang.String
  • Required : No
  • Expression : ${destDir}
  • Default : apidocs

extraParameters

No Description.

  • Type : net.israfil.mojo.flex2.Parameter[]
  • Required : No
  • Expression : ${flex.extraParameters}

finalName

Name of the generated compiled binary file.

  • Type : java.lang.String
  • Required : Yes
  • Expression : ${project.build.finalName}

flexConfig

The location of the flex configuration file.

  • Type : java.io.File
  • Required : No
  • Expression : ${flex.config}

flexHome

The directory in which Flex (command-line or builder) is installed.

  • Type : java.io.File
  • Required : Yes
  • Expression : ${flex.home}

javaOpts

These are additional JVM options used when invoking the Flex compiler

  • Type : java.lang.String[]
  • Required : No
  • Expression : ${flex.java.options}

name

Report name

  • Type : java.lang.String
  • Required : Yes
  • Default : ASDocs

projectHelper

No Description.

  • Type : org.apache.maven.project.MavenProjectHelper
  • Required : No

reportOutputDirectory

Specifies the destination directory where javadoc saves the generated HTML files.

  • Type : java.io.File
  • Required : Yes
  • Expression : ${project.reporting.outputDirectory}/apidocs

siteRenderer

Generates the site report

  • Type : javax.swing.Renderer
  • Required : No

source

Location of the flex sources.

  • Type : java.io.File
  • Required : No
  • Expression : ${flex.compiler.source}