Add explanation in RefasterCollectionTestUtilTest.java

PicnicSupermarket · Mar 31, 2022 · 60b1d21 · 60b1d21
1 parent 1c7b580
commit 60b1d21
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/...rt/src/test/java/tech/picnic/errorprone/refaster/test/RefasterCollectionTestUtilTest.java b/...rt/src/test/java/tech/picnic/errorprone/refaster/test/RefasterCollectionTestUtilTest.java
@@ -3,7 +3,15 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 
-/** Validate error reporting of the Refaster template collections. */
+/**
+ * Validate error reporting of the Refaster template collections.
+ *
+ * <p>The goal of the Refaster template collections under test is to verify the reporting of {@link
+ * RefasterCollectionTestUtil} using the associated `TestInput` and `TestOutput` files. Normally,
+ * {@link RefasterCollectionTestUtil} will report error messages directly in the console where the
+ * results of the tests are shown. However, to verify that these messages are correct, the
+ * `*TestOutput` files in this package contain error reporting that is normally not written.
+ */
 final class RefasterCollectionTestUtilTest {
   @ParameterizedTest
   @ValueSource(