From a19ec5072f2b3db9c6c15325101d9694aa0c49be Mon Sep 17 00:00:00 2001 From: andreoss Date: Thu, 15 Apr 2021 16:35:54 -0400 Subject: [PATCH] (#1579) Improve javadoc --- src/main/java/org/cactoos/text/Abbreviated.java | 2 +- src/main/java/org/cactoos/text/Base64Decoded.java | 2 +- src/main/java/org/cactoos/text/Base64Encoded.java | 2 +- src/main/java/org/cactoos/text/Concatenated.java | 2 +- src/main/java/org/cactoos/text/PrefixOf.java | 6 +++--- src/main/java/org/cactoos/text/TextOf.java | 12 ++++++------ src/main/java/org/cactoos/text/TextOfScalar.java | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/main/java/org/cactoos/text/Abbreviated.java b/src/main/java/org/cactoos/text/Abbreviated.java index 1afa64ef3..02f6997e1 100644 --- a/src/main/java/org/cactoos/text/Abbreviated.java +++ b/src/main/java/org/cactoos/text/Abbreviated.java @@ -53,7 +53,7 @@ public final class Abbreviated extends TextEnvelope { * *

By default, the max line width is 80 characters. * - * @param text The Text + * @param text The CharSequence */ public Abbreviated(final CharSequence text) { this(new TextOf(text)); diff --git a/src/main/java/org/cactoos/text/Base64Decoded.java b/src/main/java/org/cactoos/text/Base64Decoded.java index dccb90aad..e34ed6c2a 100644 --- a/src/main/java/org/cactoos/text/Base64Decoded.java +++ b/src/main/java/org/cactoos/text/Base64Decoded.java @@ -37,7 +37,7 @@ public final class Base64Decoded extends TextEnvelope { /** * Ctor. * - * @param input The String + * @param input The CharSequence */ public Base64Decoded(final CharSequence input) { this(new TextOf(input)); diff --git a/src/main/java/org/cactoos/text/Base64Encoded.java b/src/main/java/org/cactoos/text/Base64Encoded.java index 0b558fa00..84ac8741a 100644 --- a/src/main/java/org/cactoos/text/Base64Encoded.java +++ b/src/main/java/org/cactoos/text/Base64Encoded.java @@ -38,7 +38,7 @@ public final class Base64Encoded extends TextEnvelope { /** * Ctor. * - * @param input The String + * @param input The CharSequence */ public Base64Encoded(final CharSequence input) { this(new TextOf(input)); diff --git a/src/main/java/org/cactoos/text/Concatenated.java b/src/main/java/org/cactoos/text/Concatenated.java index de3f70ff5..f0ceab96b 100644 --- a/src/main/java/org/cactoos/text/Concatenated.java +++ b/src/main/java/org/cactoos/text/Concatenated.java @@ -46,7 +46,7 @@ public Concatenated(final Text... txts) { /** * Ctor. - * @param strs Strings to be concatenated + * @param strs CharSequences to be concatenated */ public Concatenated(final CharSequence... strs) { this( diff --git a/src/main/java/org/cactoos/text/PrefixOf.java b/src/main/java/org/cactoos/text/PrefixOf.java index 8e3199cd8..99374d4ca 100644 --- a/src/main/java/org/cactoos/text/PrefixOf.java +++ b/src/main/java/org/cactoos/text/PrefixOf.java @@ -40,8 +40,8 @@ public final class PrefixOf extends TextEnvelope { /** * Ctor. - * @param text Text representing the text value - * @param boundary String to which text will be split + * @param text CharSequence representing the text value + * @param boundary CharSequence to which text will be split */ public PrefixOf(final CharSequence text, final CharSequence boundary) { this(new TextOf(text), boundary); @@ -50,7 +50,7 @@ public PrefixOf(final CharSequence text, final CharSequence boundary) { /** * Ctor. * @param text Text representing the text value - * @param boundary String to which text will be split + * @param boundary CharSequence to which text will be split */ public PrefixOf(final Text text, final CharSequence boundary) { this(text, new TextOf(boundary)); diff --git a/src/main/java/org/cactoos/text/TextOf.java b/src/main/java/org/cactoos/text/TextOf.java index aca4a5378..4e1a52865 100644 --- a/src/main/java/org/cactoos/text/TextOf.java +++ b/src/main/java/org/cactoos/text/TextOf.java @@ -169,20 +169,20 @@ public TextOf(final Reader rdr, final int max, final Charset cset) { /** * Ctor. * - * @param builder The String builder + * @param str The CharSequence */ - public TextOf(final CharSequence builder) { - this(new BytesOf(builder)); + public TextOf(final CharSequence str) { + this(new BytesOf(str)); } /** * Ctor. * - * @param builder The String builder + * @param str The CharSequence * @param cset The Charset */ - public TextOf(final CharSequence builder, final Charset cset) { - this(new BytesOf(builder, cset), cset); + public TextOf(final CharSequence str, final Charset cset) { + this(new BytesOf(str, cset), cset); } /** diff --git a/src/main/java/org/cactoos/text/TextOfScalar.java b/src/main/java/org/cactoos/text/TextOfScalar.java index dfb99d8e1..12a4a6e22 100644 --- a/src/main/java/org/cactoos/text/TextOfScalar.java +++ b/src/main/java/org/cactoos/text/TextOfScalar.java @@ -39,14 +39,14 @@ public final class TextOfScalar implements Text { /** - * String value of the envelope. + * Value of the envelope. */ private final Scalar origin; /** * Ctor. * - * @param scalar The Scalar of String + * @param scalar The scalar of CharSequence */ public TextOfScalar(final Scalar scalar) { this.origin = scalar;