Author: bentmann
Date: Sat Dec 18 00:18:09 2010
New Revision: 1050544

URL: http://svn.apache.org/viewvc?rev=1050544&view=rev
Log:
[MPLUGIN-178] Generated help mojo should indicate parameter expression and 
required status

Modified:
    
maven/plugin-tools/trunk/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java
    
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java

Modified: 
maven/plugin-tools/trunk/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java?rev=1050544&r1=1050543&r2=1050544&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java
 Sat Dec 18 00:18:09 2010
@@ -33,6 +33,7 @@ public class MyMojo
 
     /**
      * @parameter expression="${test.undocumented}"
+     * @required
      */
     private String undocumentedParam;
 

Modified: 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java?rev=1050544&r1=1050543&r2=1050544&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
 Sat Dec 18 00:18:09 2010
@@ -582,11 +582,12 @@ public class PluginHelpGenerator
         {
             String parameterName = StringUtils.escape( parameter.getName() );
             String parameterDescription = toDescription( 
parameter.getDescription() );
-            String parameterDefaultValue = parameterName
-                + ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) ? " 
(Default: "
-                    + StringUtils.escape( parameter.getDefaultValue() ) + ")" 
: "" );
-
-            writer.write( "                append( sb, \"" + 
parameterDefaultValue + "\", 2 );" + LS );
+            String parameterDefaultValue = "";
+            if ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) )
+            {
+                parameterDefaultValue = " (Default: " + StringUtils.escape( 
parameter.getDefaultValue() ) + ")";
+            }
+            writer.write( "                append( sb, \"" + parameterName + 
parameterDefaultValue + "\", 2 );" + LS );
             if ( StringUtils.isNotEmpty( parameter.getDeprecated() ) )
             {
                 writer.write( "                append( sb, \"Deprecated. " + 
toDescription( parameter.getDeprecated() )
@@ -594,6 +595,15 @@ public class PluginHelpGenerator
                 writer.write( "                append( sb, \"\", 0 );" + LS );
             }
             writer.write( "                append( sb, \"" + 
parameterDescription + "\", 3 );" + LS );
+            if ( parameter.isRequired() )
+            {
+                writer.write( "                append( sb, \"Required: Yes\", 
3 );" + LS );
+            }
+            if ( StringUtils.isNotEmpty( parameter.getExpression() ) )
+            {
+                writer.write( "                append( sb, \"Expression: "
+                    + StringUtils.escape( parameter.getExpression() ) + "\", 3 
);" + LS );
+            }
             writer.write( "                append( sb, \"\", 0 );" + LS );
         }
     }


Reply via email to