From 19c16c4f28efbe5f86977a8394cb953db6f34bc4 Mon Sep 17 00:00:00 2001 From: Vincent Siveton Date: Sat, 17 Nov 2007 13:29:16 +0000 Subject: [PATCH] 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 --- .../plugin/generator/PluginXdocGenerator.java | 48 +++++++++++++++---- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java index 2d2bd7c..2ef74a2 100644 --- a/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java +++ b/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java @@ -240,9 +240,9 @@ public class PluginXdocGenerator 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; } - private void writeParameterDetails( List parameterList, XMLWriter w ) + private void writeParameterDetails( MojoDescriptor mojoDescriptor, List parameterList, XMLWriter w ) { w.startElement( "subsection" ); w.addAttribute( "name", "Parameter Details" ); @@ -294,12 +294,22 @@ public class PluginXdocGenerator w.endElement(); //p w.startElement( "ul" ); - + writeDetail( "Deprecated", parameter.getDeprecated(), 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() ) { @@ -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 ); if ( requiredParams.size() > 0 ) { - writeParameterList( "Required Parameters", requiredParams, w ); + writeParameterList( mojoDescriptor, "Required Parameters", requiredParams, w ); } List optionalParams = getParametersByRequired( false, parameterList ); 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.addAttribute( "name", title ); @@ -367,6 +377,9 @@ public class PluginXdocGenerator w.writeText( "Type" ); w.endElement();//th w.startElement( "th" ); + w.writeText( "Since" ); + w.endElement();//th + w.startElement( "th" ); w.writeText( "Description" ); w.endElement();//th w.endElement();//tr @@ -384,6 +397,23 @@ public class PluginXdocGenerator w.writeMarkup( "" + parameter.getType().substring( index + 1 ) + "" ); w.endElement();//td w.startElement( "td" ); + if ( StringUtils.isNotEmpty( parameter.getSince() ) ) + { + w.writeMarkup( "" + parameter.getSince() + "" ); + } + else + { + if ( StringUtils.isNotEmpty( mojoDescriptor.getSince() ) ) + { + w.writeMarkup( "" + mojoDescriptor.getSince() + "" ); + } + else + { + w.writeMarkup( "-" ); + } + } + w.endElement();//td + w.startElement( "td" ); String description = parameter.getDescription(); if ( StringUtils.isEmpty( description ) ) {