From 1ef2b2e74eb73c69b87ec409b919bee7a8745143 Mon Sep 17 00:00:00 2001 From: Herve Boutemy Date: Mon, 21 May 2012 22:37:15 +0000 Subject: [PATCH] improved javadoc git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@1341236 13f79535-47bb-0310-9956-ffa450edef68 --- .../maven/tools/plugin/generator/PluginXdocGenerator.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java index 99f0a1b..122191f 100644 --- a/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java +++ b/maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java @@ -409,7 +409,7 @@ public class PluginXdocGenerator @SuppressWarnings( "unchecked" ) List parameterList = mojoDescriptor.getParameters(); - //remove components and read-only parameters + // remove components and read-only parameters List 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. */