You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by mi...@apache.org on 2016/01/12 17:50:20 UTC

[12/50] logging-log4j2 git commit: Pick up Javadoc updates from revision 1722253.

Pick up Javadoc updates from revision 1722253.

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

Branch: refs/heads/LOG4J-1181
Commit: 70ddbaf8a2f798cb440c8333698f3555212b11c3
Parents: 2d98964
Author: ggregory <gg...@apache.org>
Authored: Tue Dec 29 16:38:54 2015 -0800
Committer: ggregory <gg...@apache.org>
Committed: Tue Dec 29 16:38:54 2015 -0800

----------------------------------------------------------------------
 .../log4j/core/util/StringBuilderWriter.java    | 26 +++++++++++---------
 1 file changed, 15 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/70ddbaf8/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
index 15bc4ab..d366bd6 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/StringBuilderWriter.java
@@ -27,8 +27,12 @@ import java.io.Writer;
  * (i.e. for use in a single thread) implementation for better performance.
  * For safe usage with multiple {@link Thread}s then
  * <code>java.io.StringWriter</code> should be used.
- *
- * Copied from Apache Commons IO revision 1681000.
+ * 
+ * <h3>History</h3>
+ * <ol>
+ * <li>Copied from Apache Commons IO revision 1681000.</li>
+ * <li>Pick up Javadoc updates from revision 1722253.</li>
+ * <ol>
  */
 public class StringBuilderWriter extends Writer implements Serializable {
 
@@ -36,14 +40,14 @@ public class StringBuilderWriter extends Writer implements Serializable {
     private final StringBuilder builder;
 
     /**
-     * Construct a new {@link StringBuilder} instance with default capacity.
+     * Constructs a new {@link StringBuilder} instance with default capacity.
      */
     public StringBuilderWriter() {
         this.builder = new StringBuilder();
     }
 
     /**
-     * Construct a new {@link StringBuilder} instance with the specified capacity.
+     * Constructs a new {@link StringBuilder} instance with the specified capacity.
      *
      * @param capacity The initial capacity of the underlying {@link StringBuilder}
      */
@@ -52,7 +56,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Construct a new instance with the specified {@link StringBuilder}.
+     * Constructs a new instance with the specified {@link StringBuilder}.
      * 
      * <p>If {@code builder} is null a new instance with default capacity will be created.</p>
      *
@@ -63,7 +67,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Append a single character to this Writer.
+     * Appends a single character to this Writer.
      *
      * @param value The character to append
      * @return This writer instance
@@ -75,7 +79,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Append a character sequence to this Writer.
+     * Appends a character sequence to this Writer.
      *
      * @param value The character to append
      * @return This writer instance
@@ -87,7 +91,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Append a portion of a character sequence to the {@link StringBuilder}.
+     * Appends a portion of a character sequence to the {@link StringBuilder}.
      *
      * @param value The character to append
      * @param start The index of the first character
@@ -118,7 +122,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
 
 
     /**
-     * Write a String to the {@link StringBuilder}.
+     * Writes a String to the {@link StringBuilder}.
      * 
      * @param value The value to write
      */
@@ -130,7 +134,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Write a portion of a character array to the {@link StringBuilder}.
+     * Writes a portion of a character array to the {@link StringBuilder}.
      *
      * @param value The value to write
      * @param offset The index of the first character
@@ -144,7 +148,7 @@ public class StringBuilderWriter extends Writer implements Serializable {
     }
 
     /**
-     * Return the underlying builder.
+     * Returns the underlying builder.
      *
      * @return The underlying builder
      */