Reporting Plugins

Added by Stephen Duncan, last edited by Wendy Smoak on Jun 02, 2007  (view change)

Reporting Plugins

Configuration

Reporting plugins are configured in the POM as in this example:

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

Configuration in the reporting section also applies if plugin goals are invoked individually. The converse is not true-- if you configure the plugin inside <build>, that configuration will NOT apply to <reporting>.

Configuring multiple reports for one plugin using <reportSets>. Each <reportSet> must have a unique <id>. For more information on UMLGraph, see the UMLGraph site and this page.

<project>
   ...
    <reporting>
       <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <reportSets>
               <reportSet>
                  <id>uml</id>
                  <configuration>
                     <doclet>gr.spinellis.umlgraph.doclet.UmlGraph</doclet>
                     <docletArtifact>
                        <groupId>gr.spinellis</groupId>
                        <artifactId>UmlGraph</artifactId>
                        <version>4.4</version>
                     </docletArtifact>
                     <additionalparam>-views</additionalparam>
                     <destDir>target/uml</destDir>
                     <show>private</show>
                  </configuration>
                  <reports>
                     <report>javadoc</report>
                  </reports>
               </reportSet>
               <reportSet>
                  <id>html</id>
                  <configuration>
                     <show>private</show>
                  </configuration>
                  <reports>
                     <report>javadoc</report>
                  </reports>
               </reportSet>
            </reportSets>
         </plugin>
      ...
      </plugins>
   <reporting>
</project>

Known Plugins That Provide Reports

Labels

 
(None)