Question

It appears that that you can generate a standard documentation website (like this one) from a Maven plugin project. I tried executing mvn site in a plugin project but it doesn’t generate the expected documentation (a page that shows the Mojo goals, parameters, etc.). Is there some other goal that must be invoked to generate these web pages? I’m using Maven v. 2.1.0.

Answer 1

In order to get the plugin documentation (goals, params, etc.) included in the site documentation, you need to add the following to the pom.xml

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-plugin</artifactId>
        <version>2.5.1</version>
      </plugin>
    </plugins>
  </reporting>    
  ...
</project>

This adds a “Project Reports” link to the site menu, which shows the Maven plugin’s equivalent of Javadoc.