commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chtom...@apache.org
Subject [3/4] [text] (docs) minor javadoc improvements.
Date Tue, 05 Sep 2017 18:43:27 GMT
(docs) minor javadoc improvements.


Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/e47c0359
Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/e47c0359
Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/e47c0359

Branch: refs/heads/master
Commit: e47c03594c8307105b5aa5c933ae9503aabfcf21
Parents: 96e0bc1
Author: Rob Tompkins <chtompki@apache.org>
Authored: Tue Sep 5 14:42:02 2017 -0400
Committer: Rob Tompkins <chtompki@apache.org>
Committed: Tue Sep 5 14:42:02 2017 -0400

----------------------------------------------------------------------
 .../java/org/apache/commons/text/CaseUtils.java |  2 +-
 .../commons/text/RandomStringGenerator.java     | 22 ++++++++++++--------
 2 files changed, 14 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-text/blob/e47c0359/src/main/java/org/apache/commons/text/CaseUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/CaseUtils.java b/src/main/java/org/apache/commons/text/CaseUtils.java
index ae2067e..40bc7cd 100644
--- a/src/main/java/org/apache/commons/text/CaseUtils.java
+++ b/src/main/java/org/apache/commons/text/CaseUtils.java
@@ -36,7 +36,7 @@ public class CaseUtils {
      * <p><code>CaseUtils</code> instances should NOT be constructed in
      * standard programming. Instead, the class should be used as
      * <code>CaseUtils.toCamelCase("foo bar", true, new char[]{'-'});</code>.</p>
-     * <p>
+     *
      * <p>This constructor is public to permit tools that require a JavaBean
      * instance to operate.</p>
      */

http://git-wip-us.apache.org/repos/asf/commons-text/blob/e47c0359/src/main/java/org/apache/commons/text/RandomStringGenerator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/RandomStringGenerator.java b/src/main/java/org/apache/commons/text/RandomStringGenerator.java
index b0d6b08..a6c01c3 100644
--- a/src/main/java/org/apache/commons/text/RandomStringGenerator.java
+++ b/src/main/java/org/apache/commons/text/RandomStringGenerator.java
@@ -328,10 +328,14 @@ public final class RandomStringGenerator {
          * generated string.
          * </p>
          *
-         * Ex.
-         * char [][] pairs = {{'0','9'}};
-         * char [][] pairs = {{'a','z'}};
-         * char [][] pairs = {{'a','z'},{'0','9'}};
+         * For example:
+         * <pre>
+         * {@code
+         *     char [][] pairs = {{'0','9'}};
+         *     char [][] pairs = {{'a','z'}};
+         *     char [][] pairs = {{'a','z'},{'0','9'}};
+         * }
+         * </pre>
          *
          * @param pairs array of charachters array, expected is to pass min, max pairs through
this arg.
          * @return {@code this}, to allow method chaining.
@@ -401,11 +405,11 @@ public final class RandomStringGenerator {
          * </p>
          * <pre>
          * {@code
-         * UniformRandomProvider rng = RandomSource.create(...);
-         * RandomStringGenerator gen = new RandomStringGenerator.Builder()
-         *     .usingRandom(rng::nextInt)
-         *     // additional builder calls as needed
-         *     .build();
+         *     UniformRandomProvider rng = RandomSource.create(...);
+         *     RandomStringGenerator gen = new RandomStringGenerator.Builder()
+         *         .usingRandom(rng::nextInt)
+         *         // additional builder calls as needed
+         *         .build();
          * }
          * </pre>
          *


Mime
View raw message