From ad3b12f25951153675c2ab4596964718fa1dc571 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Victor=20No=C3=ABl?= <victor.noel@crazydwarves.org>
Date: Tue, 8 May 2018 18:21:40 +0200
Subject: [PATCH] improve `IteratorOfXXX` documentation #838

---
 src/main/java/org/cactoos/iterator/IteratorOf.java            | 2 +-
 src/main/java/org/cactoos/iterator/IteratorOfBooleans.java    | 2 +-
 src/main/java/org/cactoos/iterator/IteratorOfChars.java       | 2 +-
 src/main/java/org/cactoos/iterator/IteratorOfFloats.java      | 2 +-
 src/main/java/org/cactoos/iterator/IteratorOfInts.java        | 2 +-
 .../java/org/cactoos/iterator/IteratorOfBooleansTest.java     | 4 +---
 src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java   | 4 +---
 src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java  | 2 --
 src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java    | 2 --
 9 files changed, 7 insertions(+), 15 deletions(-)

diff --git a/src/main/java/org/cactoos/iterator/IteratorOf.java b/src/main/java/org/cactoos/iterator/IteratorOf.java
index 0fcf2f89e9..39bafba556 100644
--- a/src/main/java/org/cactoos/iterator/IteratorOf.java
+++ b/src/main/java/org/cactoos/iterator/IteratorOf.java
@@ -28,7 +28,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Iterator that returns the set of elements.
+ * {@link Iterator} that returns the elements.
  *
  * <p>There is no thread-safety guarantee.</p>
  *
diff --git a/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java b/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java
index f0ea483410..87837d2069 100644
--- a/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java
+++ b/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java
@@ -28,7 +28,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Iterator that returns the set of booleans.
+ * {@link Iterator} that returns the {@code boolean}s as {@link Boolean}s.
  *
  * <p>There is no thread-safety guarantee.</p>
  *
diff --git a/src/main/java/org/cactoos/iterator/IteratorOfChars.java b/src/main/java/org/cactoos/iterator/IteratorOfChars.java
index 3fd4e17002..6d38bf7cb3 100644
--- a/src/main/java/org/cactoos/iterator/IteratorOfChars.java
+++ b/src/main/java/org/cactoos/iterator/IteratorOfChars.java
@@ -28,7 +28,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Iterator that returns the set of chars.
+ * {@link Iterator} that returns the {@code char}s as {@link Character}s.
  *
  * <p>There is no thread-safety guarantee.</p>
  *
diff --git a/src/main/java/org/cactoos/iterator/IteratorOfFloats.java b/src/main/java/org/cactoos/iterator/IteratorOfFloats.java
index b1f0e588fc..688d6d394c 100644
--- a/src/main/java/org/cactoos/iterator/IteratorOfFloats.java
+++ b/src/main/java/org/cactoos/iterator/IteratorOfFloats.java
@@ -28,7 +28,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Iterator that returns the set of floats.
+ * {@link Iterator} that returns the {@code float}s as {@link Float}s.
  *
  * <p>There is no thread-safety guarantee.</p>
  *
diff --git a/src/main/java/org/cactoos/iterator/IteratorOfInts.java b/src/main/java/org/cactoos/iterator/IteratorOfInts.java
index d775727ffa..73e4c446a0 100644
--- a/src/main/java/org/cactoos/iterator/IteratorOfInts.java
+++ b/src/main/java/org/cactoos/iterator/IteratorOfInts.java
@@ -28,7 +28,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
- * Iterator that returns the set of integers.
+ * {@link Iterator} that returns the {@code int}s as {@link Integer}s.
  *
  * <p>There is no thread-safety guarantee.</p>
  *
diff --git a/src/test/java/org/cactoos/iterator/IteratorOfBooleansTest.java b/src/test/java/org/cactoos/iterator/IteratorOfBooleansTest.java
index 8396221e05..ff0fbe3b81 100644
--- a/src/test/java/org/cactoos/iterator/IteratorOfBooleansTest.java
+++ b/src/test/java/org/cactoos/iterator/IteratorOfBooleansTest.java
@@ -29,9 +29,7 @@
 import org.junit.Test;
 
 /**
- * Iterator that returns the set of booleans.
- *
- * <p>There is no thread-safety guarantee.</p>
+ * Tests for {@link IteratorOfBooleans}.
  *
  * @since 0.32
  * @checkstyle JavadocMethodCheck (500 lines)
diff --git a/src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java b/src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java
index acc8e7fa17..06fa1f90db 100644
--- a/src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java
+++ b/src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java
@@ -29,9 +29,7 @@
 import org.junit.Test;
 
 /**
- * Iterator that returns the set of chars.
- *
- * <p>There is no thread-safety guarantee.</p>
+ * Tests for {@link IteratorOfChars}.
  *
  * @since 0.32
  * @checkstyle JavadocMethodCheck (500 lines)
diff --git a/src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java b/src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java
index 44ff118306..2f01529fcf 100644
--- a/src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java
+++ b/src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java
@@ -31,8 +31,6 @@
 /**
  * Tests for {@link IteratorOfFloats}.
  *
- * <p>There is no thread-safety guarantee.</p>
- *
  * @since 0.32
  * @checkstyle JavadocMethodCheck (500 lines)
  */
diff --git a/src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java b/src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java
index 0ea4f68425..6b2713d514 100644
--- a/src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java
+++ b/src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java
@@ -31,8 +31,6 @@
 /**
  * Tests for {@link IteratorOfInts}.
  *
- * <p>There is no thread-safety guarantee.</p>
- *
  * @since 0.32
  * @checkstyle JavadocMethodCheck (500 lines)
  */