Add TODOs for parameterized test annotation documentation

Issue: #830
junit-team · May 3, 2017 · abfdc05 · abfdc05
1 parent a3e4b97
commit abfdc05
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 2 deletions.
diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTest.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedTest.java
@@ -66,11 +66,10 @@
 public @interface ParameterizedTest {
 
 	/**
-	 * TODO Document name().
-	 *
 	 * @return a custom display name; never blank or consisting solely of
 	 * whitespace
 	 */
+	// TODO [#830] Document name().
 	String name() default "[{index}] {arguments}";
 
 }
diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvFileSource.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvFileSource.java
@@ -39,12 +39,16 @@
 @ArgumentsSource(CsvFileArgumentsProvider.class)
 public @interface CsvFileSource {
 
+	// TODO [#830] Document resources().
 	String[] resources();
 
+	// TODO [#830] Document encoding().
 	String encoding() default "UTF-8";
 
+	// TODO [#830] Document lineSeparator().
 	String lineSeparator() default "\n";
 
+	// TODO [#830] Document delimiter().
 	char delimiter() default ',';
 
 }
diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvSource.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvSource.java
@@ -39,8 +39,10 @@
 @ArgumentsSource(CsvArgumentsProvider.class)
 public @interface CsvSource {
 
+	// TODO [#830] Document value().
 	String[] value();
 
+	// TODO [#830] Document delimiter().
 	char delimiter() default ',';
 
 }
diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/MethodSource.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/MethodSource.java
@@ -40,6 +40,7 @@
 @ArgumentsSource(MethodArgumentsProvider.class)
 public @interface MethodSource {
 
+	// TODO [#830] Document names().
 	String[] names();
 
 }
diff --git a/...upiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java b/...upiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java
@@ -46,4 +46,5 @@ public void accept(ValueSource source) {
 	public Stream<? extends Arguments> provideArguments(ContainerExtensionContext context) {
 		return Arrays.stream(arguments).map(ObjectArrayArguments::arguments);
 	}
+
 }
diff --git a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueSource.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueSource.java
@@ -42,12 +42,16 @@
 @ArgumentsSource(ValueArgumentsProvider.class)
 public @interface ValueSource {
 
+	// TODO [#830] Document strings().
 	String[] strings() default {};
 
+	// TODO [#830] Document ints().
 	int[] ints() default {};
 
+	// TODO [#830] Document longs().
 	long[] longs() default {};
 
+	// TODO [#830] Document doubles().
 	double[] doubles() default {};
 
 }