You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bi...@apache.org on 2012/08/07 20:46:53 UTC

svn commit: r1370429 - /maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java

Author: bimargulies
Date: Tue Aug  7 18:46:52 2012
New Revision: 1370429

URL: http://svn.apache.org/viewvc?rev=1370429&view=rev
Log:
MWAR-284: overlay parameter documentation is missing

Modified:
    maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java

Modified: maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java?rev=1370429&r1=1370428&r2=1370429&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java (original)
+++ maven/plugins/trunk/maven-war-plugin/src/main/java/org/apache/maven/plugin/war/AbstractWarMojo.java Tue Aug  7 18:46:52 2012
@@ -19,13 +19,6 @@ package org.apache.maven.plugin.war;
  * under the License.
  */
 
-import java.io.File;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-
 import org.apache.maven.archiver.MavenArchiveConfiguration;
 import org.apache.maven.artifact.factory.ArtifactFactory;
 import org.apache.maven.execution.MavenSession;
@@ -57,6 +50,13 @@ import org.codehaus.plexus.archiver.mana
 import org.codehaus.plexus.util.FileUtils;
 import org.codehaus.plexus.util.StringUtils;
 
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
 /**
  * Contains common jobs for WAR mojos.
  *
@@ -233,6 +233,23 @@ public abstract class AbstractWarMojo
     /**
      * The overlays to apply.
      *
+     * Each <overlay> element may contain:
+     * <ul>
+     *     <li>id (defaults to <tt>currentBuild</tt>)</li>
+     *     <li>groupId (if this and artifactId are null, then the current project is treated as its own overlay)</li>
+     *     <li>artifactId (see above)</li>
+     *     <li>classifier</li>
+     *     <li>type</li>
+     *     <li>includes (a list of string patterns)</li>
+     *     <li>excludes (a list of string patterns)</li>
+     *     <li>filtered (defaults to false)</li>
+     *     <li>skip (defaults to false)</li>
+     *     <li>targetPath (defaults to root of webapp structure)</li>
+     *
+     * </ul>
+     *
+     *
+     *
      * @since 2.1-alpha-1
      */
     @Parameter