From 22f392113fb81788cb67af2561f57910015f74a6 Mon Sep 17 00:00:00 2001
From: Ben Culkin <scorpress@gmail.com>
Date: Sat, 13 Mar 2021 10:13:35 -0500
Subject: Update the documentation

---
 src/main/java/bjc/inflexion/QueuedIterator.java | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/src/main/java/bjc/inflexion/QueuedIterator.java b/src/main/java/bjc/inflexion/QueuedIterator.java
index 0dc98a1..edef1f5 100644
--- a/src/main/java/bjc/inflexion/QueuedIterator.java
+++ b/src/main/java/bjc/inflexion/QueuedIterator.java
@@ -19,7 +19,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 +31,10 @@ 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.
 	 */
 	@SafeVarargs
@@ -41,8 +45,10 @@ 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.
 	 */
 	@SafeVarargs
@@ -50,9 +56,7 @@ public class QueuedIterator<E> implements Iterator<E> {
 		return new QueuedIterator<>(itrs);
 	}
 
-	/**
-	 * Create a new queued iterator that starts blank.
-	 */
+	/** Create a new queued iterator that starts blank. */
 	public QueuedIterator() {
 		pending = new ArrayDeque<>();
 	}
@@ -60,8 +64,7 @@ public class QueuedIterator<E> implements Iterator<E> {
 	/**
 	 * Create a new queued iterator with a set of initial sources.
 	 *
-	 * @param inits
-	 *              The set of initial iterators to use.
+	 * @param inits The set of initial iterators to use.
 	 */
 	@SafeVarargs
 	public QueuedIterator(Iterator<E>... inits) {
-- 
cgit v1.2.3