Integrating the documentation to Maven Site

The Maven Flex Plugin provides Maven report so the API Documentation can be integrated to the Maven Site generation.

Integrating ASDoc documentation for a simple Flex project

To add the ASDoc API Documentation to the site generation, add the report to the reporting section of the POM. Please note the ASDoc template should be specified as defined in this document .

...
    <reporting>
        <plugins>
            <plugin>
                <groupId>org.servebox.flex</groupId>
                <artifactId>flex-plugin</artifactId>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>asdoc-report</report>
                        </reports>
                    </reportSet>
                </reportSets>
                <configuration>
                    <asDocTemplateDependency>
                        <groupId>com.adobe.flex</groupId>
                        <artifactId>asdoc-template</artifactId>
                    </asDocTemplateDependency>
                    <leftFramesetWidth>320</leftFramesetWidth>
                </configuration>
            </plugin>
        </plugins>
    </reporting>
...

Integrating ASDoc documentation for a multi-module project

To add the ASDoc API Documentation to the site generation for an aggregator project, add the report to the reporting section of the POM. Please note the ASDoc template should be specified as defined in this document .

To avoid the reporting configuration to be inherited by the sub-projects, the inherits property is set to false .

...
    <reporting>
        <plugins>
            <plugin>
                <groupId>org.servebox.flex</groupId>
                <artifactId>flex-plugin</artifactId>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>asdoc-report</report>
                        </reports>
                    </reportSet>
                </reportSets>
                <configuration>
                    <asDocTemplateDependency>
                        <groupId>com.adobe.flex</groupId>
                        <artifactId>asdoc-template</artifactId>
                    </asDocTemplateDependency>
                    <leftFramesetWidth>320</leftFramesetWidth>
                </configuration>
            </plugin>
        </plugins>
    </reporting>
...