Maven: The Complete Reference

13.6. FlexMojos Plugin Reports

The FlexMojos Maven Plugin contains the following report:

flexmojos:asdoc-report
Generates documentation for Actionscript sources as a report that can be included in a Maven site

13.6.1. Generating Actionscript Documentation Report

To generate the asdoc-report as part of your Maven site build, add the following XML to your POM:

Configuring the Actionscript Documentation Report. 

<reporting>
    <plugins>
        <plugin>
            <groupId>org.sonatype.flexmojos</groupId>
            <artifactId>flexmojos-maven-plugin</artifactId>
            <version>${flexmojos.version}</version>
            <reportSets>
                <reportSet>
                    <id>flex-reports</id>
                    <reports>
                        <report>asdoc-report</report>
                    </reports>
                </reportSet>
            </reportSets>
        </plugin>
    </plugins>
</reporting>

When you run mvn site, Maven will generate this report and place the results under the "Project Reports" menu as shown in Figure 13.10, “Actionscript Documentation Report on Maven Site”.

figs/web/flex-dev_asdocs-report.png

Figure 13.10. Actionscript Documentation Report on Maven Site


If you need to pass in any configuration options to the asdoc-report, you will need add a configuration element to the reportSets element as shown in Configuring the asdoc-report.

Configuring the asdoc-report. 

<reporting>
    <plugins>
        <plugin>
            <groupId>org.sonatype.flexmojos</groupId>
            <artifactId>flexmojos-maven-plugin</artifactId>
            <version>${flexmojos.version}</version>
            <reportSets>
                <reportSet>
                    <id>flex-reports</id>
                    <reports>
                        <report>asdoc-report</report>
                    </reports>
                    <configuration>
                        <windowTitle>My TEST API Doc</windowTitle>
                        <footer>Copyright 2010 Sonatype</footer>
                    </configuration>
                </reportSet>
            </reportSets>
        </plugin>
    </plugins>
</reporting>