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

[hb...@apache.org]

Author: hboutemy
Date: Fri Jul 15 21:22:16 2016
New Revision: 1752880

URL: http://svn.apache.org/viewvc?rev=1752880&view=rev
Log:
[MSHARED-562] added documentation on the styled message API

Added:
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java   (with props)

Added: 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=1752880&view=auto
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java (added)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java Fri Jul 15 21:22:16 2016
@@ -0,0 +1,47 @@
+// CHECKSTYLE_OFF: RegexpHeader
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+/**
+ * An API to write Maven messages to console with styled color content, consistently across whole
+ * Maven ecosystem (Maven itself or any plugin or extension). 
+ * <p>
+ * Messages are built with instances of {@link org.apache.maven.shared.utils.logging.MessageBuffer MessageBuffer}
+ * which provides a fluent API.
+ * {@link org.apache.maven.shared.utils.logging.MessageUtils MessageUtils} gives access to these buffers.
+ * <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>success</code>, <code>failure</code>, <code>strong</code>, <code>mojo</code> and <code>project</code> for
+ * message content</li>
+ * </ul>
+ * Default styles colors can be configured through system properties, that can be set in <code>MAVEN_OPTS</code>
+ * environment variable (eventually in <code>.mavenrc</code> script):<ul>
+ * <li>system properties are named <code>style.&lt;style name&gt;</code>,</li>
+ * <li>values are comma separated combination of <code>bold</code>, <code>&lt;color&gt;</code> and
+ * <code>bg&lt;color&gt;</code> (for background), where <code>&lt;color&gt;</code> is 
+ * an <a href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI color</a>: <code>black</code>,
+ * <code>red</code>, <code>green</code>, <code>yellow</code>, <code>blue</code>, <code>magenta</code>,
+ * <code>cyan</code> or <code>white</code>, eventually with <code>bright</code> prefix</li>
+ * </ul>
+ */
+package org.apache.maven.shared.utils.logging;
+

Propchange: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/logging/package-info.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain