svn commit: r1416310 - /maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt

[hb...@apache.org]

Author: hboutemy
Date: Sun Dec  2 23:48:50 2012
New Revision: 1416310

URL: http://svn.apache.org/viewvc?rev=1416310&view=rev
Log:
added a section about aggregate reports

Modified:
    maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt

Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt?rev=1416310&r1=1416309&r2=1416310&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt Sun Dec  2 23:48:50 2012
@@ -94,3 +94,36 @@ Building multi-module sites
   ...
 </project>
 +-----+
+
+* Aggregate Reports
+
+  Some reports can be run against the sum of every modules: these are aggregate reports. This is the case of
+  maven-javadoc-plugin, maven-jxr-plugin or maven-checkstyle-plugin.
+
+  To benefit from aggregate reports, you must configure a reportSet in the parent pom, and turn inheritance off to avoid
+  the aggregate report to be run in modules. For example, with maven-jxr-report:
+
++--------------+
+<project>
+  ...
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>2.3</version>
+        <reportSets>
+          <reportSet>
+            <id>aggregate</id>
+            <inherited>false</inherited>
+            <reports>
+              <report>aggregate</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+    </plugins>
+  </reporting>
+  ...
+</project>
++--------------+