improve IteratorOfXXX documentation yegor256#838

victornoel · May 10, 2018 · 302afec · 302afec
1 parent 1e43297
commit 302afec
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 20 deletions.
diff --git a/src/main/java/org/cactoos/iterator/IteratorOf.java b/src/main/java/org/cactoos/iterator/IteratorOf.java
@@ -28,8 +28,8 @@
 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>
  *
  * @author Yegor Bugayenko (yegor256@gmail.com)

diff --git a/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java b/src/main/java/org/cactoos/iterator/IteratorOfBooleans.java
@@ -28,8 +28,8 @@
 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>
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)

diff --git a/src/main/java/org/cactoos/iterator/IteratorOfChars.java b/src/main/java/org/cactoos/iterator/IteratorOfChars.java
@@ -28,8 +28,8 @@
 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>
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)

diff --git a/src/main/java/org/cactoos/iterator/IteratorOfFloats.java b/src/main/java/org/cactoos/iterator/IteratorOfFloats.java
@@ -28,8 +28,8 @@
 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>
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)

diff --git a/src/main/java/org/cactoos/iterator/IteratorOfInts.java b/src/main/java/org/cactoos/iterator/IteratorOfInts.java
@@ -28,8 +28,8 @@
 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>
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)

diff --git 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}.
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)
  * @version $Id$

diff --git 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}.
  *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)
  * @version $Id$

diff --git 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>
- *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)
  * @version $Id$
  * @since 0.32

diff --git 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>
- *
  * @author Krzysztof Krason (Krzysztof.Krason@gmail.com)
  * @version $Id$
  * @since 0.32