From 9ea26413d99ec18fc84eb24db95bc28904909032 Mon Sep 17 00:00:00 2001 From: Benjamin Bentmann Date: Sat, 18 Dec 2010 00:18:09 +0000 Subject: [PATCH] [MPLUGIN-178] Generated help mojo should indicate parameter expression and required status git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1050544 13f79535-47bb-0310-9956-ffa450edef68 --- .../help-basic/src/main/java/test/MyMojo.java | 1 + .../plugin/generator/PluginHelpGenerator.java | 20 ++++++++++++++----- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java b/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java index f7a5d59..447bb51 100644 --- a/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java +++ b/maven-plugin-plugin/src/it/help-basic/src/main/java/test/MyMojo.java @@ -33,6 +33,7 @@ public class MyMojo /** * @parameter expression="${test.undocumented}" + * @required */ private String undocumentedParam; diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java index e741b17..59488c3 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java @@ -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 ); } }