Choosing a template for ASDoc

The ASDoc tool uses a template to create the API documentation. This template is composed of several XML, XLS, HTML files describing the layout of the documentation.

The Maven Flex Plugin considers the ASDoc template as a project dependency. To create your own template, you might use the default template as a starting point and deploy it to your repository. Or you may use the default template provided by Adobe, available from the plugin repository.

To use a template, simply include the ZIP file as a project dependency, and reffer to it using the asDocTemplateDependency property of the configuration section.

...
    <build>
    ...
        <plugins>
            <plugin>
                <groupId>org.servebox.flex</groupId>
                <artifactId>flex-plugin</artifactId>
                <version>2.3.2</version>
                <extensions>true</extensions>
                <configuration>
                    <asDocTemplateDependency>
                        <groupId>com.adobe.flex</groupId>
                        <artifactId>asdoc-template</artifactId>
                    </asDocTemplateDependency>
                    <leftFramesetWidth>320</leftFramesetWidth>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        ...
        <dependency>
            <groupId>com.adobe.flex</groupId>
            <artifactId>asdoc-template</artifactId>
            <version>3.1.0.2710</version>
            <type>zip</type>
            <scope>provided</scope>
        </dependency>
    </dependencies>
...