summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/data/QueuedIterator.java
diff options
context:
space:
mode:
authorBen Culkin <scorpress@gmail.com>2021-03-13 10:15:01 -0500
committerBen Culkin <scorpress@gmail.com>2021-03-13 10:15:01 -0500
commit46c719b5538e8728f3f840b87064ddb04fa85517 (patch)
tree3a4ecbd9f74fb9207db98e549071d229b94e10d1 /src/main/java/bjc/data/QueuedIterator.java
parent1b9aa36ee069938d49dc719dd0f23b6d877229cc (diff)
Update documentation
Diffstat (limited to 'src/main/java/bjc/data/QueuedIterator.java')
-rw-r--r--src/main/java/bjc/data/QueuedIterator.java22
1 files changed, 13 insertions, 9 deletions
diff --git a/src/main/java/bjc/data/QueuedIterator.java b/src/main/java/bjc/data/QueuedIterator.java
index 78f180d..805fc5e 100644
--- a/src/main/java/bjc/data/QueuedIterator.java
+++ b/src/main/java/bjc/data/QueuedIterator.java
@@ -9,8 +9,7 @@ import java.util.Iterator;
*
* @author bjculkin
*
- * @param <E>
- * The type of element this iterator iterates over
+ * @param <E> The type of element this iterator iterates over
*/
public class QueuedIterator<E> implements Iterator<E> {
private Iterator<E> cur;
@@ -19,7 +18,9 @@ public class QueuedIterator<E> implements Iterator<E> {
/**
* Static method for constructing iterators.
- *
+ *
+ * @param <E> The type of element this iterator iterates over
+ *
* @return A queued iterator.
*/
public static <E> QueuedIterator<E> queued() {
@@ -29,8 +30,9 @@ public class QueuedIterator<E> implements Iterator<E> {
/**
* Static method for constructing iterators.
*
- * @param vals
- * The values to iterate over.
+ * @param <E> The type of element this iterator iterates over
+ *
+ * @param vals The values to iterate over.
*
* @return A queued iterator.
*/
@@ -42,8 +44,9 @@ public class QueuedIterator<E> implements Iterator<E> {
/**
* Static method for constructing iterators.
*
- * @param itrs
- * The iterators to use.
+ * @param <E> The type of element this iterator iterates over
+ *
+ * @param itrs The iterators to use.
*
* @return A queued iterator over the provided iterators.
*/
@@ -55,8 +58,9 @@ public class QueuedIterator<E> implements Iterator<E> {
/**
* Static method for constructing iterators.
*
- * @param itrs
- * The iterables to use.
+ * @param <E> The type of element this iterator iterates over
+ *
+ * @param itrs The iterables to use.
*
* @return A queued iterator over the provided iterables.
*/