svn commit: r1164587 - /maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java

[bi...@apache.org]

Author: bimargulies
Date: Fri Sep  2 15:47:35 2011
New Revision: 1164587

URL: http://svn.apache.org/viewvc?rev=1164587&view=rev
Log:
[MPLUGIN-179] Clarify the goalPrefix (is there a default value for example) param

Modified:
    maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java

Modified: maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java?rev=1164587&r1=1164586&r2=1164587&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-plugin/src/main/java/org/apache/maven/plugin/plugin/PluginReport.java Fri Sep  2 15:47:35 2011
@@ -124,7 +124,18 @@ public class PluginReport
     private Requirements requirements;
 
     /**
-     * The goal prefix that will appear before the ":".
+     * The goal prefix that will appear before the ":". 
+     * By default, this plugin applies a heuristic to derive a heuristic from 
+     * the plugin's artifactId. 
+     * 
+     * It removes any occurrences of the regular expression <strong>-?maven-?</strong>,
+     * and then removes any occurrences of <strong>-?plugin-?</strong>.
+     * <p>
+     * For example, horsefeature-maven-plugin becomes horsefeather.
+     * </p>
+     * <p>
+     * (There is a special for maven-plugin-plugin; it is mapped to 'plugin'.
+     * </p>
      *
      * @parameter expression="${goalPrefix}"
      * @since 2.4