javadoc fix for #871

yegor256 · May 22, 2018 · 8684193 · 8684193
1 parent 995eb06
commit 8684193
Show file tree

Hide file tree

Showing 25 changed files with 51 additions and 37 deletions.
diff --git a/src/main/java/org/cactoos/scalar/And.java b/src/main/java/org/cactoos/scalar/And.java
@@ -70,7 +70,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/AndInThreads.java b/src/main/java/org/cactoos/scalar/AndInThreads.java
@@ -44,7 +44,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/AndWithIndex.java b/src/main/java/org/cactoos/scalar/AndWithIndex.java
@@ -56,7 +56,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/AvgOf.java b/src/main/java/org/cactoos/scalar/AvgOf.java
@@ -44,7 +44,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/BoolOf.java b/src/main/java/org/cactoos/scalar/BoolOf.java
@@ -35,7 +35,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @since 0.2
  */

diff --git a/src/main/java/org/cactoos/scalar/Equals.java b/src/main/java/org/cactoos/scalar/Equals.java
@@ -33,7 +33,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @param <T> Type of object to compare
  * @since 0.9

diff --git a/src/main/java/org/cactoos/scalar/HighestOf.java b/src/main/java/org/cactoos/scalar/HighestOf.java
@@ -46,7 +46,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/IoCheckedScalar.java b/src/main/java/org/cactoos/scalar/IoCheckedScalar.java
@@ -27,15 +27,15 @@
 import org.cactoos.Scalar;
 
 /**
- * Scalar that doesn't throw checked {@link Exception}, but throws
+ * Scalar that doesn't throw {@link Exception}, but throws
  * {@link IOException} instead.
  *
  * <p>There is no thread-safety guarantee.
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
+ * {@link IOException}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator.</p>
  *
  * @param <T> Type of result
  * @since 0.4

diff --git a/src/main/java/org/cactoos/scalar/LowestOf.java b/src/main/java/org/cactoos/scalar/LowestOf.java
@@ -46,7 +46,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/MaxOf.java b/src/main/java/org/cactoos/scalar/MaxOf.java
@@ -40,7 +40,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/MinOf.java b/src/main/java/org/cactoos/scalar/MinOf.java
@@ -42,7 +42,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @since 0.24
  */

diff --git a/src/main/java/org/cactoos/scalar/Not.java b/src/main/java/org/cactoos/scalar/Not.java
@@ -33,7 +33,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @since 0.7
  */

diff --git a/src/main/java/org/cactoos/scalar/NumberOf.java b/src/main/java/org/cactoos/scalar/NumberOf.java
@@ -41,7 +41,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @since 0.2
  */

diff --git a/src/main/java/org/cactoos/scalar/Or.java b/src/main/java/org/cactoos/scalar/Or.java
@@ -72,7 +72,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @since 0.8
  */

diff --git a/src/main/java/org/cactoos/scalar/Reduced.java b/src/main/java/org/cactoos/scalar/Reduced.java
@@ -66,7 +66,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @param <T> Scalar type
  * @since 0.30

diff --git a/src/main/java/org/cactoos/scalar/RetryScalar.java b/src/main/java/org/cactoos/scalar/RetryScalar.java
@@ -47,7 +47,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * @param <T> Type of output
  * @since 0.9

diff --git a/src/main/java/org/cactoos/scalar/StickyScalar.java b/src/main/java/org/cactoos/scalar/StickyScalar.java
@@ -39,7 +39,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <pre>{@code
  * final Scalar<Integer> scalar = new StickyScalar<>(

diff --git a/src/main/java/org/cactoos/scalar/SumOf.java b/src/main/java/org/cactoos/scalar/SumOf.java
@@ -43,7 +43,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/SumOfDoubleScalar.java b/src/main/java/org/cactoos/scalar/SumOfDoubleScalar.java
@@ -35,9 +35,8 @@
  * }</pre>
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
- * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * {@link Exception}. Despite that this class does NOT throw a checked
+ * exception.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/SumOfFloatScalar.java b/src/main/java/org/cactoos/scalar/SumOfFloatScalar.java
@@ -35,9 +35,8 @@
  * }</pre>
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
- * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * {@link Exception}. Despite that this class does NOT throw a checked
+ * exception.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/SumOfIntScalar.java b/src/main/java/org/cactoos/scalar/SumOfIntScalar.java
@@ -36,9 +36,8 @@
  * }</pre>
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
- * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * {@link Exception}. Despite that this class does NOT throw a checked
+ * exception.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/SumOfLongScalar.java b/src/main/java/org/cactoos/scalar/SumOfLongScalar.java
@@ -35,9 +35,8 @@
  * }</pre>
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
- * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * {@link Exception}. Despite that this class does NOT throw a checked
+ * exception.</p>
  *
  * <p>There is no thread-safety guarantee.
  *

diff --git a/src/main/java/org/cactoos/scalar/SumOfScalar.java b/src/main/java/org/cactoos/scalar/SumOfScalar.java
@@ -32,9 +32,8 @@
  * Make a scalar which is sum of scalar's values.
  *
  * <p>This class implements {@link Scalar}, which throws a checked
- * {@link Exception}. This may not be convenient in many cases. To make
- * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * {@link Exception}. Despite that this class does NOT throw a checked
+ * exception.</p>
  *
  * <p>There is no thread-safety guarantee.
  * <p>Note this class is for internal usage only

diff --git a/src/main/java/org/cactoos/scalar/SyncScalar.java b/src/main/java/org/cactoos/scalar/SyncScalar.java
@@ -31,7 +31,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <pre>{@code
  * final List<Integer> list = new LinkedList<>();

diff --git a/src/main/java/org/cactoos/scalar/Ternary.java b/src/main/java/org/cactoos/scalar/Ternary.java
@@ -34,7 +34,8 @@
  * <p>This class implements {@link Scalar}, which throws a checked
  * {@link Exception}. This may not be convenient in many cases. To make
  * it more convenient and get rid of the checked exception you can
- * use {@link UncheckedScalar} or {@link IoCheckedScalar} decorators.</p>
+ * use the {@link UncheckedScalar} decorator. Or you may use
+ * {@link IoCheckedScalar} to wrap it in an IOException.</p>
  *
  * <pre>{@code
  * new Ternary<>(