diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/AbstractMojoTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/AbstractMojoTaglet.java index 65e7aa3..9fb136f 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/AbstractMojoTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/AbstractMojoTaglet.java @@ -213,10 +213,10 @@ public abstract class AbstractMojoTaglet /** * Append a tag * - * @param sb - * @param tag - * @param tagAttributes - * @param tagValue + * @param sb not null + * @param tag not null + * @param tagAttributes not null + * @param tagValue not null */ private void appendTag( StringBuffer sb, Tag tag, MutableAttributeSet tagAttributes, String tagValue ) { @@ -380,7 +380,8 @@ public abstract class AbstractMojoTaglet * Splits the provided text into a array, using pipe as the separator. * * @param text not null - * @return a list of parsed Strings or Collections.EMPTY_LIST. By convention, the default value is the first element. + * @return a list of parsed Strings or Collections.EMPTY_LIST. + * By convention, the default value is the first element. */ private static List getOnlyValues( String text ) { diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoAggregatorTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoAggregatorTypeTaglet.java index 7f25593..fb48c07 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoAggregatorTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoAggregatorTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoAggregatorTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.AGGREGATOR; + /** The Javadoc text which will be added to the generated page */ protected static final String HEADER = "Aggregates the Maven project and its child modules."; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoComponentFieldTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoComponentFieldTaglet.java index 391eb43..e3ac717 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoComponentFieldTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoComponentFieldTaglet.java @@ -54,12 +54,14 @@ import com.sun.tools.doclets.Taglet; public class MojoComponentFieldTaglet extends AbstractMojoFieldTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.COMPONENT; private static final String[] COMPONENTS_NAME = { JavaMojoAnnotation.COMPONENT_ROLE, JavaMojoAnnotation.COMPONENT_ROLEHINT }; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is a Plexus component defined by"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoConfiguratorTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoConfiguratorTypeTaglet.java index d3bd07d..8ea4d88 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoConfiguratorTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoConfiguratorTypeTaglet.java @@ -55,8 +55,10 @@ import com.sun.tools.doclets.Taglet; public class MojoConfiguratorTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.CONFIGURATOR; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is configured to the role hint"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecuteTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecuteTypeTaglet.java index cf50565..b6cda2b 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecuteTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecuteTypeTaglet.java @@ -55,6 +55,7 @@ import com.sun.tools.doclets.Taglet; public class MojoExecuteTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.EXECUTE; private static final String[] PARAMETERS_NAME = { @@ -62,6 +63,7 @@ public class MojoExecuteTypeTaglet JavaMojoAnnotation.EXECUTE_LIFECYCLE, JavaMojoAnnotation.EXECUTE_GOAL }; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is defined to be executed in"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecutionStrategyTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecutionStrategyTypeTaglet.java index a004d6d..2254fea 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecutionStrategyTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoExecutionStrategyTypeTaglet.java @@ -55,8 +55,10 @@ import com.sun.tools.doclets.Taglet; public class MojoExecutionStrategyTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.EXECUTION_STATEGY; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is executed with the strategy"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoGoalTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoGoalTypeTaglet.java index 3727137..2452f9e 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoGoalTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoGoalTypeTaglet.java @@ -55,8 +55,10 @@ import com.sun.tools.doclets.Taglet; public class MojoGoalTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.GOAL; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is defined by the goal name"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInheritByDefaultTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInheritByDefaultTypeTaglet.java index 69ac6a6..d5c3e09 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInheritByDefaultTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInheritByDefaultTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoInheritByDefaultTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.INHERIT_BY_DEFAULT; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is this Mojo inherited"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInstantiationStrategyTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInstantiationStrategyTypeTaglet.java index cb43e6d..550c952 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInstantiationStrategyTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoInstantiationStrategyTypeTaglet.java @@ -55,8 +55,10 @@ import com.sun.tools.doclets.Taglet; public class MojoInstantiationStrategyTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.INSTANTIATION_STRATEGY; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is instantiated with the strategy"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java index eb68090..2ef4e9f 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoParameterFieldTaglet.java @@ -55,6 +55,7 @@ import com.sun.tools.doclets.Taglet; public class MojoParameterFieldTaglet extends AbstractMojoFieldTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.PARAMETER; private static final String[] PARAMETERS_NAME = { @@ -64,6 +65,7 @@ public class MojoParameterFieldTaglet JavaMojoAnnotation.PARAMETER_IMPLEMENTATION, JavaMojoAnnotation.PARAMETER_PROPERTY }; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is defined by"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoPhaseTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoPhaseTypeTaglet.java index 5266741..9349e97 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoPhaseTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoPhaseTypeTaglet.java @@ -55,8 +55,10 @@ import com.sun.tools.doclets.Taglet; public class MojoPhaseTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.PHASE; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is bound to the specified phase of the standard build lifecycle"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoReadOnlyFieldTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoReadOnlyFieldTaglet.java index 04275f2..fad9278 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoReadOnlyFieldTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoReadOnlyFieldTaglet.java @@ -59,8 +59,10 @@ import com.sun.tools.doclets.Taglet; public class MojoReadOnlyFieldTaglet extends AbstractMojoFieldTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.READONLY; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is readonly."; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiredFieldTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiredFieldTaglet.java index b9549eb..241ba71 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiredFieldTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiredFieldTaglet.java @@ -59,8 +59,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiredFieldTaglet extends AbstractMojoFieldTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRED; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Is required."; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyResolutionTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyResolutionTypeTaglet.java index 8ddb563..82f24a6 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyResolutionTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDependencyResolutionTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiresDependencyResolutionTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRES_DEPENDENCY_RESOLUTION; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Requires the dependencies in this specified scope"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDirectInvocationTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDirectInvocationTypeTaglet.java index 33ce819..24e37d0 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDirectInvocationTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresDirectInvocationTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiresDirectInvocationTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRES_DIRECT_INVOCATION; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Requires a direct invocation by the user"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresOnLineTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresOnLineTypeTaglet.java index 8fca80b..c0be2b2 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresOnLineTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresOnLineTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiresOnLineTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRES_ONLINE; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Requires to be online to run"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresProjectTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresProjectTypeTaglet.java index 5b4a8ef..53ca21c 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresProjectTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresProjectTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiresProjectTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRES_PROJECT; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Requires a Maven project to run"; /** diff --git a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresReportsTypeTaglet.java b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresReportsTypeTaglet.java index c1ec4d6..d134e96 100644 --- a/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresReportsTypeTaglet.java +++ b/maven-plugin-tools-javadoc/src/main/java/org/apache/maven/tools/plugin/javadoc/MojoRequiresReportsTypeTaglet.java @@ -56,8 +56,10 @@ import com.sun.tools.doclets.Taglet; public class MojoRequiresReportsTypeTaglet extends AbstractMojoTypeTaglet { + /** The Javadoc annotation */ private static final String NAME = JavaMojoAnnotation.REQUIRES_REPORTS; + /** The Javadoc text which will be added to the generated page. */ protected static final String HEADER = "Requires Maven reports to run"; /**