Skip to content

Commit

Permalink
improve IteratorOfXXX documentation #838
Browse files Browse the repository at this point in the history
  • Loading branch information
victornoel committed May 15, 2018
1 parent 3ac3c79 commit ad3b12f
Show file tree
Hide file tree
Showing 9 changed files with 7 additions and 15 deletions.
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/iterator/IteratorOf.java
Original file line number Diff line number Diff line change
Expand Up @@ -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>
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/iterator/IteratorOfBooleans.java
Original file line number Diff line number Diff line change
Expand Up @@ -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>
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/iterator/IteratorOfChars.java
Original file line number Diff line number Diff line change
Expand Up @@ -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>
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/iterator/IteratorOfFloats.java
Original file line number Diff line number Diff line change
Expand Up @@ -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>
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/cactoos/iterator/IteratorOfInts.java
Original file line number Diff line number Diff line change
Expand Up @@ -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>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 1 addition & 3 deletions src/test/java/org/cactoos/iterator/IteratorOfCharsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions src/test/java/org/cactoos/iterator/IteratorOfFloatsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
/**
* Tests for {@link IteratorOfFloats}.
*
* <p>There is no thread-safety guarantee.</p>
*
* @since 0.32
* @checkstyle JavadocMethodCheck (500 lines)
*/
Expand Down
2 changes: 0 additions & 2 deletions src/test/java/org/cactoos/iterator/IteratorOfIntsTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
/**
* Tests for {@link IteratorOfInts}.
*
* <p>There is no thread-safety guarantee.</p>
*
* @since 0.32
* @checkstyle JavadocMethodCheck (500 lines)
*/
Expand Down

0 comments on commit ad3b12f

Please sign in to comment.