Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h1>Reporting Plugins</h1>

<h2>Configuration</h2>

<p>Reporting plugins are configured in the POM as in this example:</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;project>
  ...
  &lt;reporting>
    &lt;plugins>
      &lt;plugin>
        &lt;groupId>org.apache.maven.plugins&lt;/groupId>
        &lt;artifactId>maven-project-info-reports-plugin&lt;/artifactId>
      &lt;/plugin>
    &lt;/plugins>
  &lt;/reporting>
  ...
&lt;/project>
</pre></td></tr></table>
<p>Configuration in the reporting section also applies if plugin goals are invoked individually.  The converse is not true-- if you configure the plugin inside &lt;build&gt;, that configuration will NOT apply to &lt;reporting&gt;.</p>

<p>Configuring multiple reports for one plugin using &lt;reportSets&gt;.  Each &lt;reportSet&gt; must have a unique &lt;id&gt;.  For more information on UMLGraph, see <a href="http://www.spinellis.gr/sw/umlgraph/">the UMLGraph site</a> and <a href="http://wiki.wsmoak.net/cgi-bin/wiki.pl?UMLGraph">this page</a>.</p>
<table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;project>
   ...
    &lt;reporting>
       &lt;plugins>
         &lt;plugin>
            &lt;groupId>org.apache.maven.plugins&lt;/groupId>
            &lt;artifactId>maven-javadoc-plugin&lt;/artifactId>
            &lt;reportSets>
               &lt;reportSet>
                  &lt;id>uml&lt;/id>
                  &lt;configuration>
                     &lt;doclet>gr.spinellis.umlgraph.doclet.UmlGraph&lt;/doclet>
                     &lt;docletArtifact>
                        &lt;groupId>gr.spinellis&lt;/groupId>
                        &lt;artifactId>UmlGraph&lt;/artifactId>
                        &lt;version>4.4&lt;/version>
                     &lt;/docletArtifact>
                     &lt;additionalparam>-views&lt;/additionalparam>
                     &lt;destDir>target/uml&lt;/destDir>
                     &lt;show>private&lt;/show>
                  &lt;/configuration>
                  &lt;reports>
                     &lt;report>javadoc&lt;/report>
                  &lt;/reports>
               &lt;/reportSet>
               &lt;reportSet>
                  &lt;id>html&lt;/id>
                  &lt;configuration>
                     &lt;show>private&lt;/show>
                  &lt;/configuration>
                  &lt;reports>
                     &lt;report>javadoc&lt;/report>
                  &lt;/reports>
               &lt;/reportSet>
            &lt;/reportSets>
         &lt;/plugin>
      ...
      &lt;/plugins>
   &lt;/reporting>
&lt;/project>
</pre></td></tr></table>

<h2>Known Plugins That Provide Reports</h2>

<ul>
	<li><a href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/">Project-Info-Reports</a> - Standard Reports</li>
	<li><a href="http://maven.apache.org/plugins/maven-javadoc-plugin/">Javadoc</a> - Javadoc</li>
	<li><a href="http://mojo.codehaus.org/jxr-maven-plugin/">JXR</a> - Source Cross-Reference</li>
	<li><a href="http://mojo.codehaus.org/surefire-report-maven-plugin/">Surefire-Report</a> - Surefire Test Report</li>
	<li><a href="http://mojo.codehaus.org/changes-maven-plugin/">Changes</a> - Changes &amp; JIRA Report</li>
	<li><a href="http://mojo.codehaus.org/taglist-maven-plugin/">Taglist</a> - Taglist Report (For TODO, @deprecated, etc.)</li>
	<li><a href="http://maven.apache.org/plugins/maven-pmd-plugin/">PMD</a> - PMD Report for Source-code analysis</li>
</ul>