[MPLUGIN-179] Clarify the goalPrefix (is there a default value for example) param

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1164587 13f79535-47bb-0310-9956-ffa450edef68
master
Benson Margulies 2011-09-02 15:47:35 +00:00
parent 8a41324bbd
commit 20c5286c7c
1 changed files with 12 additions and 1 deletions

View File

@ -124,7 +124,18 @@ public class PluginReport
private Requirements requirements; 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}" * @parameter expression="${goalPrefix}"
* @since 2.4 * @since 2.4