Plugin Documentation

Goals available for this plugin:

GoalReport?Description
mailetdocs:helpNoDisplay help information on maven-mailetdocs-plugin.
Call 
 mvn mailetdocs:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
mailetdocs:mailetdocsYes

Generates catalog and reports on mailets and matchers.

Notes

  • Should only used as a report.
  • Mailets are instantiated during report production.

System Requirements

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

Maven2.0
JDK1.4
MemoryNo minimum requirement.
Disk SpaceNo 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.apache.james</groupId>
          <artifactId>maven-mailetdocs-plugin</artifactId>
          <version>0.2-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.james</groupId>
        <artifactId>maven-mailetdocs-plugin</artifactId>
        <version>0.2-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.james</groupId>
        <artifactId>maven-mailetdocs-plugin</artifactId>
        <version>0.2-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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