stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[MPLUGIN-307] The "alias" field on the annotation "@Parameter" is not considered for goal "plugin:report" 

PluginXdocGenerator didn't include the alias for parameters in the report. Added to the end of the bullet list.

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1754050 13f79535-47bb-0310-9956-ffa450edef68
master
Guillaume Boué 2016-07-25 21:19:22 +00:00
parent a44d4f1719
commit 22fcf70b89
6 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
View File

@ -543,6 +543,10 @@ public class PluginXdocGenerator
addedUl = addUl( w, addedUl, parameter.getDefaultValue() );
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.default" ),
escapeXml( parameter.getDefaultValue() ), w );
addedUl = addUl( w, addedUl, parameter.getAlias() );
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.alias" ), escapeXml( parameter.getAlias() ),
w );
if ( addedUl )
{
@ -719,6 +723,13 @@ public class PluginXdocGenerator
if ( property != null )
{
w.writeMarkup( format( "pluginxdoc.mojodescriptor.parameter.property.description", property ) );
w.writeMarkup( "<br/>" );
}
if ( StringUtils.isNotEmpty( parameter.getAlias() ) )
{
w.writeMarkup( format( "pluginxdoc.mojodescriptor.parameter.alias.description",
escapeXml( parameter.getAlias() ) ) );
}
w.endElement(); //td

2
maven-plugin-tools-generators/src/main/resources/pluginxdoc.properties
View File

@ -53,6 +53,8 @@ pluginxdoc.mojodescriptor.parameter.property=User Property
pluginxdoc.mojodescriptor.parameter.property.description=<strong>User property is</strong>: <code>{0}</code>.
pluginxdoc.mojodescriptor.parameter.default=Default
pluginxdoc.mojodescriptor.parameter.defaultValue=<strong>Default value is</strong>: <code>{0}</code>.
pluginxdoc.mojodescriptor.parameter.alias=Alias
pluginxdoc.mojodescriptor.parameter.alias.description=<strong>Alias is</strong>: <code>{0}</code>.
pluginxdoc.mojodescriptor.requiredParameters=Required Parameters
pluginxdoc.mojodescriptor.optionalParameters=Optional Parameters
pluginxdoc.mojodescriptor.parameters=Parameters

2
maven-plugin-tools-generators/src/main/resources/pluginxdoc_de.properties
View File

@ -47,6 +47,8 @@ pluginxdoc.mojodescriptor.parameter.required=Erforderlich
pluginxdoc.mojodescriptor.parameter.expression=Ausdruck
pluginxdoc.mojodescriptor.parameter.default=Standard
pluginxdoc.mojodescriptor.parameter.defaultValue=<strong>Standardwert ist</strong>: <code>{0}</code>.
pluginxdoc.mojodescriptor.parameter.alias=Alias
pluginxdoc.mojodescriptor.parameter.alias.description=<strong>Alias ist</strong>: <code>{0}</code>.
pluginxdoc.mojodescriptor.requiredParameters=Erforderliche Parameter
pluginxdoc.mojodescriptor.optionalParameters=Optionale Parameter
pluginxdoc.mojodescriptor.parameters=Parameter

2
maven-plugin-tools-generators/src/main/resources/pluginxdoc_fr.properties
View File

@ -52,6 +52,8 @@ pluginxdoc.mojodescriptor.parameter.property=Propri\u00e9t\u00e9 utilisateur
pluginxdoc.mojodescriptor.parameter.property.description=<strong>Propri\u00e9t\u00e9 utilisateur</strong> : <code>{0}</code>.
pluginxdoc.mojodescriptor.parameter.default=D\u00e9faut
pluginxdoc.mojodescriptor.parameter.defaultValue=<strong>Valeur par d\u00e9faut</strong> : <code>{0}</code>.
pluginxdoc.mojodescriptor.parameter.alias=Alias
pluginxdoc.mojodescriptor.parameter.alias.description=<strong>Alias</strong> : <code>{0}</code>.
pluginxdoc.mojodescriptor.requiredParameters=Param\u00e8tres requis
pluginxdoc.mojodescriptor.optionalParameters=Param\u00e8tres optionnels
pluginxdoc.mojodescriptor.parameters=Param\u00e8tres

1
maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/AbstractGeneratorTestCase.java
View File

@ -77,6 +77,7 @@ public abstract class AbstractGeneratorTestCase
param.setRequired( true );
param.setType( "java.lang.String" );
param.setDescription( "Test parameter description" );
param.setAlias( "some.alias" );
params.add( param );

1
maven-plugin-tools-generators/src/test/java/org/apache/maven/tools/plugin/generator/PluginDescriptorGeneratorTest.java
View File

@ -115,6 +115,7 @@ public class PluginDescriptorGeneratorTest
assertEquals( "dir", parameter.getName() );
assertEquals( String.class.getName(), parameter.getType() );
assertTrue( parameter.isRequired() );
assertEquals( "some.alias", parameter.getAlias() );
}
private void checkDependency( String groupId, String artifactId, String version, ComponentDependency dependency )