Plugin Documentation

Goals available for this plugin:

Goal Report? Description
flex:asdoc No 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).

flex:asdoc-aggregate No Generate documentation at the ASDoc format for an aggregator project. 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.
flex:asdoc-aggregator-report Yes Generate documentation at the ASDoc format for an aggregator project.
flex:asdoc-report Yes Generate report for Maven site at the ASDoc format.
flex:deployswc No Deploy a SWC artifact to the remote repository.
flex:deployswf No Deploy a SWF artifact to the remote repository.
flex:eclipse No Create the project descriptors used by FlexBuilder plugin :
- .project
- .flexProperties
- .actionScriptProperties
By default, if this goal is run on a multiproject root, dependencies between modules will be configured as project dependencies.
flex:installswc No Install a SWC artifact to the local repository.
flex:installswf No Install a SWF artifact to the remote repository.
flex:makeswc No Build MXML and AS files to a SWC artifact.
flex:makeswf No Build MXML and AS files to a SWF application artifact.
flex:test No Compile MXML and AS files into a test SWF and process unit tests. By default, all files with a name matching Test*.as or Test*.mxml found in the test source directory will be marked for inclusion. To ignore a TestCase or TestSuite, include the metadata tag [IgnoreTest] at the class-level of your ActionScript code.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0
JDK 1.5
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.servebox.flex</groupId>
          <artifactId>flex-plugin</artifactId>
          <version>2.3.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.servebox.flex</groupId>
        <artifactId>flex-plugin</artifactId>
        <version>2.3.2</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.servebox.flex</groupId>
        <artifactId>flex-plugin</artifactId>
        <version>2.3.2</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"