svn commit: r1339661 - /maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java

[hb...@apache.org]

Author: hboutemy
Date: Thu May 17 15:49:42 2012
New Revision: 1339661

URL: http://svn.apache.org/viewvc?rev=1339661&view=rev
Log:
copied readonly definition from plugin descriptor's editable (editable = !readonly)

Modified:
    maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java

Modified: maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java?rev=1339661&r1=1339660&r2=1339661&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Parameter.java Thu May 17 15:49:42 2012
@@ -63,8 +63,14 @@ public @interface Parameter
     boolean required() default false;
 
     /**
-     * ignored...
-     * @return
+     * Specifies that this parameter cannot be configured directly by the user (as in the case of POM-specified
+     * configuration). This is useful when you want to force the user to use common POM elements rather than plugin
+     * configurations, as in the case where you want to use the artifact's final name as a parameter. In this case, you
+     * want the user to modify <code>&lt;build&gt;&lt;finalName/&gt;&lt;/build&gt;</code> rather than specifying a value
+     * for finalName directly in the plugin configuration section. It is also useful to ensure that - for example - a
+     * List-typed parameter which expects items of type Artifact doesn't get a List full of Strings.
+     * 
+     * @return <code>true</code> if the user should not be allowed to configure the parameter directly
      */
     boolean readonly() default false;
 }