Author: hboutemy
Date: Mon May 21 22:37:15 2012
New Revision: 1341236
URL: http://svn.apache.org/viewvc?rev=1341236&view=rev
Log:
improved javadoc
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
URL:
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java?rev=1341236&r1=1341235&r2=1341236&view=diff
==============================================================================
---
maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
(original)
+++
maven/plugin-tools/trunk/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
Mon May 21 22:37:15 2012
@@ -409,7 +409,7 @@ public class PluginXdocGenerator
@SuppressWarnings( "unchecked" )
List<Parameter> parameterList = mojoDescriptor.getParameters();
- //remove components and read-only parameters
+ // remove components and read-only parameters
List<Parameter> list = filterParameters( parameterList );
if ( list != null && list.size() > 0 )
@@ -432,6 +432,8 @@ public class PluginXdocGenerator
}
/**
+ * Filter parameters to only retain those which must be documented, ie not
components nor readonly.
+ *
* @param parameterList not null
* @return the parameters list without components.
*/
