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

MPLUGIN-63: Add since column in the parameters table 

o added the since column

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@595945 13f79535-47bb-0310-9956-ffa450edef68
master
Vincent Siveton 2007-11-17 13:29:16 +00:00
parent 05cd326361
commit 19c16c4f28
1 changed files with 39 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
View File

@ -240,9 +240,9 @@ public class PluginXdocGenerator
if ( list != null && list.size() > 0 ) if ( list != null && list.size() > 0 )
{ {
writeParameterSummary( list, w ); writeParameterSummary( mojoDescriptor, list, w );
writeParameterDetails( list, w ); writeParameterDetails( mojoDescriptor, list, w );
} }
} }
@ -271,7 +271,7 @@ public class PluginXdocGenerator
return filtered; return filtered;
} }
private void writeParameterDetails( List parameterList, XMLWriter w ) private void writeParameterDetails( MojoDescriptor mojoDescriptor, List parameterList, XMLWriter w )
{ {
w.startElement( "subsection" ); w.startElement( "subsection" );
w.addAttribute( "name", "Parameter Details" ); w.addAttribute( "name", "Parameter Details" );
@ -299,7 +299,17 @@ public class PluginXdocGenerator
writeDetail( "Type", parameter.getType(), w ); writeDetail( "Type", parameter.getType(), w );
writeDetail( "Since", parameter.getSince(), w ); if ( StringUtils.isNotEmpty( parameter.getSince() ) )
{
writeDetail( "Since", parameter.getSince(), w );
}
else
{
if ( StringUtils.isNotEmpty( mojoDescriptor.getSince() ) )
{
writeDetail( "Since", mojoDescriptor.getSince(), w );
}
}
if ( parameter.isRequired() ) if ( parameter.isRequired() )
{ {
@ -337,22 +347,22 @@ public class PluginXdocGenerator
} }
} }
private void writeParameterSummary( List parameterList, XMLWriter w ) private void writeParameterSummary( MojoDescriptor mojoDescriptor, List parameterList, XMLWriter w )
{ {
List requiredParams = getParametersByRequired( true, parameterList ); List requiredParams = getParametersByRequired( true, parameterList );
if ( requiredParams.size() > 0 ) if ( requiredParams.size() > 0 )
{ {
writeParameterList( "Required Parameters", requiredParams, w ); writeParameterList( mojoDescriptor, "Required Parameters", requiredParams, w );
} }
List optionalParams = getParametersByRequired( false, parameterList ); List optionalParams = getParametersByRequired( false, parameterList );
if ( optionalParams.size() > 0 ) if ( optionalParams.size() > 0 )
{ {
writeParameterList( "Optional Parameters", optionalParams, w ); writeParameterList( mojoDescriptor, "Optional Parameters", optionalParams, w );
} }
} }
private void writeParameterList( String title, List parameterList, XMLWriter w ) private void writeParameterList( MojoDescriptor mojoDescriptor, String title, List parameterList, XMLWriter w )
{ {
w.startElement( "subsection" ); w.startElement( "subsection" );
w.addAttribute( "name", title ); w.addAttribute( "name", title );
@ -367,6 +377,9 @@ public class PluginXdocGenerator
w.writeText( "Type" ); w.writeText( "Type" );
w.endElement();//th w.endElement();//th
w.startElement( "th" ); w.startElement( "th" );
w.writeText( "Since" );
w.endElement();//th
w.startElement( "th" );
w.writeText( "Description" ); w.writeText( "Description" );
w.endElement();//th w.endElement();//th
w.endElement();//tr w.endElement();//tr
@ -384,6 +397,23 @@ public class PluginXdocGenerator
w.writeMarkup( "<code>" + parameter.getType().substring( index + 1 ) + "</code>" ); w.writeMarkup( "<code>" + parameter.getType().substring( index + 1 ) + "</code>" );
w.endElement();//td w.endElement();//td
w.startElement( "td" ); w.startElement( "td" );
if ( StringUtils.isNotEmpty( parameter.getSince() ) )
{
w.writeMarkup( "<code>" + parameter.getSince() + "</code>" );
}
else
{
if ( StringUtils.isNotEmpty( mojoDescriptor.getSince() ) )
{
w.writeMarkup( "<code>" + mojoDescriptor.getSince() + "</code>" );
}
else
{
w.writeMarkup( "<code>-</code>" );
}
}
w.endElement();//td
w.startElement( "td" );
String description = parameter.getDescription(); String description = parameter.getDescription();
if ( StringUtils.isEmpty( description ) ) if ( StringUtils.isEmpty( description ) )
{ {