From 46c719b5538e8728f3f840b87064ddb04fa85517 Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Sat, 13 Mar 2021 10:15:01 -0500
Subject: Update documentation

---
 src/main/java/bjc/data/QueuedIterator.java | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

(limited to 'src/main/java/bjc/data/QueuedIterator.java')

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.
 	 */
-- 
cgit v1.2.3