o fixed checkstyle + updated javadoc

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@684240 13f79535-47bb-0310-9956-ffa450edef68
2008-08-09 12:15:40 +00:00 · 2008-08-09 12:15:40 +00:00 · 65a52813c7
parent e84fa8eeaa
commit 65a52813c7
18 changed files with 40 additions and 5 deletions
--- 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 <code>Collections.EMPTY_LIST</code>. By convention, the default value is the first element.
+     * @return a list of parsed Strings or <code>Collections.EMPTY_LIST</code>.
+     * By convention, the default value is the first element.
     */
    private static List getOnlyValues( String text )
    {
--- 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.";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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.";

    /**
--- 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.";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**
--- 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";

    /**