Javadoc cleanup in preparation of release

src/main/java/org/apache/maven/shared/utils/cli/javatool/JavaTool.java

@@ -20,17 +20,15 @@
  */
 
 /**
- * Describes a java tool, means a executable available in the jdk.
- * <p/>
- * The name of the tool ({@link #getJavaToolName()}) reflects the name of the executable that should exists as an
- * executable in the jdk, like {@code jarsigner, keytool, javadoc, ...}.
- * <p/>
- * An abstract implementation of the {@link JavaTool} named {@link AbstractJavaTool} use the command line API to execute
- * any user requests of this tool.
+ * <p>Describes a java tool, means a executable available in the jdk.</p>
+ * <p>The name of the tool ({@link #getJavaToolName()}) reflects the name of the executable that should exists as an
+ * executable in the jdk, like {@code jarsigner, keytool, javadoc, ...}.</p>
+ * <p>An abstract implementation of the {@link JavaTool} named {@link AbstractJavaTool} use the command line API to
+ * execute any user requests of this tool.</p>
  *
- * @author Tony Chemit <chemit@codelutin.com>
+ * @author <a href="mailto:chemit@codelutin.com">Tony Chemit</a>
  * @since 0.5
- * @param <Request>
+ * @param <Request> Tool-specific request type
  */
 public interface JavaTool<Request extends JavaToolRequest>
 {

src/main/java/org/apache/maven/shared/utils/introspection/ReflectionValueExtractor.java

@@ -36,7 +36,6 @@
 /**
  * <p>Using simple dotted expressions to extract the values from an Object instance,
  * For example we might want to extract a value like: <code>project.build.sourceDirectory</code></p>
- * <p/>
  * <p>The implementation supports indexed, nested and mapped properties similar to the JSP way.</p>
  *
  * @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
@@ -146,14 +145,13 @@ private ReflectionValueExtractor()
 
     /**
      * <p>The implementation supports indexed, nested and mapped properties.</p>
-     * <p/>
      * <ul>
      * <li>nested properties should be defined by a dot, i.e. "user.address.street"</li>
      * <li>indexed properties (java.util.List or array instance) should be contains <code>(\\w+)\\[(\\d+)\\]</code>
      * pattern, i.e. "user.addresses[1].street"</li>
      * <li>mapped properties should be contains <code>(\\w+)\\((.+)\\)</code> pattern,
      *  i.e. "user.addresses(myAddress).street"</li>
-     * <ul>
+     * </ul>
      *
      * @param expression not null expression
      * @param root       not null object
@@ -170,14 +168,13 @@ public static Object evaluate( @Nonnull String expression, @Nullable Object root
      * <p>
      * The implementation supports indexed, nested and mapped properties.
      * </p>
-     * <p/>
      * <ul>
      * <li>nested properties should be defined by a dot, i.e. "user.address.street"</li>
      * <li>indexed properties (java.util.List or array instance) should be contains <code>(\\w+)\\[(\\d+)\\]</code>
      * pattern, i.e. "user.addresses[1].street"</li>
      * <li>mapped properties should be contains <code>(\\w+)\\((.+)\\)</code> pattern, i.e.
      * "user.addresses(myAddress).street"</li>
-     * <ul>
+     * </ul>
      *
      * @param expression not null expression
      * @param root not null object

src/main/java/org/apache/maven/shared/utils/logging/MessageBuilder.java

@@ -29,36 +29,48 @@ public interface MessageBuilder
     /**
      * Append message content in success style.
      * By default, bold green
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder success( Object message );
 
     /**
      * Append message content in warning style.
      * By default, bold yellow
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder warning( Object message );
 
     /**
      * Append message content in failure style.
      * By default, bold red
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder failure( Object message );
 
     /**
      * Append message content in strong style.
      * By default, bold
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder strong( Object message );
 
     /**
      * Append message content in mojo style.
      * By default, green
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder mojo( Object message );
 
     /**
      * Append message content in project style.
      * By default, cyan
+     * @param message the message to append
+     * @return the current builder
      */
     MessageBuilder project( Object message );
 
@@ -67,37 +79,55 @@ public interface MessageBuilder
     //
     /**
      * Append content to the message buffer.
+     * @param value the content to append
+     * @param offset the index of the first {@code char} to append
+     * @param len the number of {@code char}s to append
+     * @return the current builder
      */
     MessageBuilder a( char[] value, int offset, int len );
 
     /**
      * Append content to the message buffer.
+     * @param value the content to append
+     * @return the current builder
      */
     MessageBuilder a( char[] value );
 
     /**
      * Append content to the message buffer.
+     * @param value the content to append
+     * @param start the starting index of the subsequence to be appended
+     * @param end the end index of the subsequence to be appended
+     * @return the current builder
      */
     MessageBuilder a( CharSequence value, int start, int end );
 
     /**
      * Append content to the message buffer.
+     * @param value the content to append
+     * @return the current builder
      */
     MessageBuilder a( CharSequence value );
 
     /**
      * Append content to the message buffer.
+     * @param value the content to append
+     * @return the current builder
      */
     MessageBuilder a( Object value );
 
     /**
      * Append newline to the message buffer.
+     * @return the current builder
      */
     MessageBuilder newline();
 
     /**
      * Append formatted content to the buffer.
      * @see String#format(String, Object...)
+     * @param pattern a <a href="../util/Formatter.html#syntax">format string</a>
+     * @param args arguments referenced by the format specifiers in the format string.
+     * @return the current builder
      */
     MessageBuilder format( String pattern, Object... args );
 }

src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java

@@ -104,7 +104,7 @@ private static void doSystemUninstall()
 
     /**
      * Enables message color (if JAnsi is available).
-     * @param flag
+     * @param flag To enable JANSI
      */
     public static void setColorEnabled( boolean flag )
     {
@@ -128,6 +128,7 @@ public static void setColorEnabled( boolean flag )
 
     /**
      * Is message color enabled: requires JAnsi available (through Maven) and the color has not been disabled.
+     * @return whether colored messages are enabled
      */
     public static boolean isColorEnabled()
     {
@@ -145,6 +146,7 @@ public static MessageBuilder buffer()
 
     /**
      * Create a message buffer with defined String builder.
+     * @param builder Initial content of the message buffer
      * @return a new buffer
      */
     public static MessageBuilder buffer( StringBuilder builder )
@@ -154,6 +156,7 @@ public static MessageBuilder buffer( StringBuilder builder )
 
     /**
      * Create a message buffer with an internal buffer of defined size.
+     * @param size size of the buffer
      * @return a new buffer
      */
     public static MessageBuilder buffer( int size )