Better Javadoc.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/f6ed16cb
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/f6ed16cb
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/f6ed16cb

Branch: refs/heads/LOG4J-1181
Commit: f6ed16cbc27a5229dd0233bfbb47cfa192d27182
Parents: 8bc8aa8
Author: ggregory <ggreg...@apache.org>
Authored: Thu Jul 7 18:22:22 2016 -0700
Committer: ggregory <ggreg...@apache.org>
Committed: Thu Jul 7 18:22:22 2016 -0700

----------------------------------------------------------------------
 .../log4j/core/pattern/JAnsiMessageRenderer.java        | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/f6ed16cb/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiMessageRenderer.java
----------------------------------------------------------------------
diff --git 
a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiMessageRenderer.java
 
b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiMessageRenderer.java
index 120f19b..ad8265f 100644
--- 
a/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiMessageRenderer.java
+++ 
b/log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/JAnsiMessageRenderer.java
@@ -28,25 +28,27 @@ import org.fusesource.jansi.AnsiRenderer.Code;
 /**
  * Renders an input as ANSI escaped output.
  * 
- * Uses the JAnsi rendering syntax to render a message into an ANSI escaped 
string.
+ * Uses the JAnsi rendering syntax as the default to render a message into an 
ANSI escaped string.
  * 
- * The syntax for embedded ANSI codes is:
+ * The default syntax for embedded ANSI codes is:
  *
  * <pre>
  *   &#64;|<em>code</em>(,<em>code</em>)* <em>text</em>|@
  * </pre>
  *
- * Examples:
+ * For example, to render the message {@code "Hello"} in green, use:
  *
  * <pre>
- *   &#64;|bold Hello|@
+ *   &#64;|green Hello|@
  * </pre>
  *
+ * To render the message {@code "Hello"} in bold and red, use:
+ *
  * <pre>
  *   &#64;|bold,red Warning!|@
  * </pre>
  * 
- * You can also define style names in the configuration:
+ * You can also define custom style names in the configuration with the syntax:
  * 
  * <pre>
  * %message{ansi}{StyleName=value(,value)*( StyleName=value(,value)*)*}%n

Reply via email to