From 46c719b5538e8728f3f840b87064ddb04fa85517 Mon Sep 17 00:00:00 2001 From: Ben Culkin Date: Sat, 13 Mar 2021 10:15:01 -0500 Subject: Update documentation --- src/test/java/bjc/TestUtils.java | 42 ++++++++++++++++------------------------ 1 file changed, 17 insertions(+), 25 deletions(-) (limited to 'src/test') diff --git a/src/test/java/bjc/TestUtils.java b/src/test/java/bjc/TestUtils.java index 29e59e1..312ebaf 100644 --- a/src/test/java/bjc/TestUtils.java +++ b/src/test/java/bjc/TestUtils.java @@ -13,10 +13,9 @@ public class TestUtils { /** * Assert an iterator provides a particular sequence of values. * - * @param src - * The iterator to pull values from. - * @param vals - * The values to expect from the iterator. + * @param The type of the values. + * @param src The iterator to pull values from. + * @param vals The values to expect from the iterator. */ @SafeVarargs public static void assertIteratorEquals(Iterator src, T... vals) { @@ -35,12 +34,10 @@ public class TestUtils { /** * Assert an iterator provides a particular sequence of values. * - * @param src - * The iterator to pull values from. - * @param hasMore - * The expected value of hasNext for the iterator. - * @param vals - * The values to expect from the iterator. + * @param The type of the values. + * @param src The iterator to pull values from. + * @param hasMore The expected value of hasNext for the iterator. + * @param vals The values to expect from the iterator. */ @SafeVarargs public static void assertIteratorEquals(boolean hasMore, Iterator src, @@ -60,10 +57,9 @@ public class TestUtils { /** * Assert an iterator provides a particular sequence of values. * - * @param src - * The iterator to pull values from. - * @param vals - * The values to expect from the iterator. + * @param The type of the values. + * @param src The iterator to pull values from. + * @param vals The values to expect from the iterator. */ @SafeVarargs public static void assertIteratorSet(Iterator src, T... vals) { @@ -88,12 +84,10 @@ public class TestUtils { /** * Assert an iterator provides a particular sequence of values. * - * @param src - * The iterator to pull values from. - * @param hasMore - * The expected value of hasNext for the iterator. - * @param vals - * The values to expect from the iterator. + * @param The type of the values. + * @param src The iterator to pull values from. + * @param hasMore The expected value of hasNext for the iterator. + * @param vals The values to expect from the iterator. */ @SafeVarargs public static void assertIteratorSet(boolean hasMore, Iterator src, @@ -113,11 +107,9 @@ public class TestUtils { /** * Assert that a list contains a certain set of values. * - * @param src - * The list to read values from. - * - * @param exps - * The values to expect in the list. + * @param The type of the values. + * @param src The list to read values from. + * @param exps The values to expect in the list. */ @SafeVarargs public static void assertListEquals(List src, T... exps) { -- cgit v1.2.3