Repository: commons-text Updated Branches: refs/heads/master 7bdd61fbf -> 343b4a9cb
Add missing JavaDoc thereby making it possible to remove relaxed checkstyle rule Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/343b4a9c Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/343b4a9c Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/343b4a9c Branch: refs/heads/master Commit: 343b4a9cbed087206bc7466f8caad910a4f059b1 Parents: 7bdd61f Author: Benedikt Ritter <brit...@apache.org> Authored: Wed May 17 14:12:56 2017 -0400 Committer: Benedikt Ritter <brit...@apache.org> Committed: Wed May 17 14:12:56 2017 -0400 ---------------------------------------------------------------------- checkstyle.xml | 4 +-- .../commons/text/RandomStringGenerator.java | 30 ++++++++++++++++++++ 2 files changed, 31 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-text/blob/343b4a9c/checkstyle.xml ---------------------------------------------------------------------- diff --git a/checkstyle.xml b/checkstyle.xml index e6cb6b2..fdea061 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -94,9 +94,7 @@ <property name="allowUndeclaredRTE" value="true"/> </module> <module name="JavadocType"/> - <module name="JavadocVariable"> - <property name="excludeScope" value="private"/> - </module> + <module name="JavadocVariable" /> <module name="JavadocStyle"/> http://git-wip-us.apache.org/repos/asf/commons-text/blob/343b4a9c/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 8596a9b..6aa6806 100644 --- a/src/main/java/org/apache/commons/text/RandomStringGenerator.java +++ b/src/main/java/org/apache/commons/text/RandomStringGenerator.java @@ -52,9 +52,24 @@ import org.apache.commons.lang3.Validate; */ public final class RandomStringGenerator { + /** + * The smallest allowed code point (inclusive). + */ private final int minimumCodePoint; + + /** + * The largest allowed code point (inclusive). + */ private final int maximumCodePoint; + + /** + * Filters for code points. + */ private final Set<CharacterPredicate> inclusivePredicates; + + /** + * The source of randomness for this generator. + */ private final TextRandomProvider random; /** @@ -198,9 +213,24 @@ public final class RandomStringGenerator { */ public static final int DEFAULT_MINIMUM_CODE_POINT = 0; + /** + * The minimum code point allowed. + */ private int minimumCodePoint = DEFAULT_MINIMUM_CODE_POINT; + + /** + * The maximum code point allowed. + */ private int maximumCodePoint = DEFAULT_MAXIMUM_CODE_POINT; + + /** + * Filters for code points. + */ private Set<CharacterPredicate> inclusivePredicates; + + /** + * The source of randomness. + */ private TextRandomProvider random; /**
