[GitHub] [maven-shared-utils] MartinKanters commented on a change in pull request #85: WIP: Javadoc cleanup in preparation of release

[GitBox <gi...@apache.org>]

MartinKanters commented on a change in pull request #85:
URL: https://github.com/apache/maven-shared-utils/pull/85#discussion_r619412886



##########
File path: 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

Review comment:
       ```suggestion
        * @param flag to enable Jansi
   ```

##########
File path: 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).

Review comment:
       Let's call it "Jansi" as it's done in [their source](https://github.com/fusesource/jansi)
   
   ```suggestion
        * Enables message color (if Jansi is available).
   ```

##########
File path: src/main/java/org/apache/maven/shared/utils/logging/MessageUtils.java
##########
@@ -145,6 +146,7 @@ public static MessageBuilder buffer()
 
     /**
      * Create a message buffer with defined String builder.
+     * @param builder Initial content of the message buffer

Review comment:
       ```suggestion
        * @param builder initial content of the message buffer
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org