You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/01/08 22:52:24 UTC

svn commit: r494209 - /maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java

Author: dennisl
Date: Mon Jan  8 13:52:23 2007
New Revision: 494209

URL: http://svn.apache.org/viewvc?view=rev&rev=494209
Log:
o Improve documentation for the moduleExcludes parameter.

Modified:
    maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java

Modified: maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java?view=diff&rev=494209&r1=494208&r2=494209
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java (original)
+++ maven/plugins/trunk/maven-site-plugin/src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java Mon Jan  8 13:52:23 2007
@@ -65,8 +65,20 @@
     extends AbstractSiteMojo
 {
     /**
-     * module type exclusion mappings
-     * ex: fml -> **\/*-m1.fml  (excludes -m1.fml files)
+     * Module type exclusion mappings
+     * ex: <code>fml  -> **&#47;*-m1.fml</code>  (excludes fml files ending in '-m1.fml' recursively)
+     * <p/>
+     * The configuration looks like this:
+     * <pre>
+     *   &lt;moduleExcludes&gt;
+     *     &lt;moduleType&gt;filename1.ext,**&#47;*sample.ext&lt;/moduleType&gt;
+     *     &lt;!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --&gt;
+     *     &lt;!-- The value is a comma separated list of           --&gt;
+     *     &lt;!-- filenames or fileset patterns.                   --&gt;
+     *     &lt;!-- Here's an example:                               --&gt;
+     *     &lt;xdoc&gt;changes.xml,navigation.xml&lt;/xdoc&gt;
+     *   &lt;/moduleExcludes&gt;
+     * </pre>
      *
      * @parameter
      */