svn commit: r1760149 - /maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java

[hb...@apache.org]

Author: hboutemy
Date: Sat Sep 10 11:42:33 2016
New Revision: 1760149

URL: http://svn.apache.org/viewvc?rev=1760149&view=rev
Log:
[MSHARED-587] improved documentation

Modified:
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java?rev=1760149&r1=1760148&r2=1760149&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java Sat Sep 10 11:42:33 2016
@@ -22,16 +22,19 @@
  * Maven ecosystem (Maven itself or any plugin or extension). 
  * <p>
  * Messages are built with instances of {@link org.apache.maven.shared.utils.logging.MessageBuilder MessageBuilder}
- * which provides a fluent API.
- * {@link org.apache.maven.shared.utils.logging.MessageUtils MessageUtils} gives access to these buffers.
+ * which provides a fluent API, while error level are colored by slf4j provider with
+ * {@link org.apache.maven.shared.utils.logging.LoggerLevelRenderer LoggerLevelRenderer}.
+ * <p>
+ * {@link org.apache.maven.shared.utils.logging.MessageUtils MessageUtils} gives access to these builders.
  * <p>
  * Plugins can use this API with any Maven version: color
  * just won't be activated when run with Maven version older than 3.4.0.
  * <p>
  * Styles are:<ul>
- * <li><code>debug</code>, <code>info</code>, <code>warning</code> and <code>error</code> for slf4j level display,</li>
+ * <li><code>debug</code>, <code>info</code>, <code>warning</code> and <code>error</code> for 
+ * {@link org.apache.maven.shared.utils.logging.LoggerLevelRenderer logger level rendering},</li>
  * <li><code>success</code>, <code>warning</code>, <code>failure</code>, <code>strong</code>, <code>mojo</code>
- * and <code>project</code> for message content</li>
+ * and <code>project</code> for {@link org.apache.maven.shared.utils.logging.MessageBuilder message content}</li>
  * </ul>
  * Default styles colors can be overridden through system properties, that can be set in <code>MAVEN_OPTS</code>
  * environment variable (eventually in <code>.mavenrc</code> script):<ul>