From abfdc052a981595c074308dc1dcd571e2c1c59d2 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Wed, 3 May 2017 13:38:52 +0200 Subject: [PATCH] Add TODOs for parameterized test annotation documentation Issue: #830 --- .../main/java/org/junit/jupiter/params/ParameterizedTest.java | 3 +-- .../java/org/junit/jupiter/params/provider/CsvFileSource.java | 4 ++++ .../java/org/junit/jupiter/params/provider/CsvSource.java | 2 ++ .../java/org/junit/jupiter/params/provider/MethodSource.java | 1 + .../junit/jupiter/params/provider/ValueArgumentsProvider.java | 1 + .../java/org/junit/jupiter/params/provider/ValueSource.java | 4 ++++ 6 files changed, 13 insertions(+), 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 index 33dcf4ba9eed..bd01856407c1 100644 --- 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 index 7322df7fb26a..94d18c7e5f53 100644 --- 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 index 61cda20f4951..862cd27b719b 100644 --- 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 index b869214c65d3..c737411767c8 100644 --- 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/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java index afca73bed2b1..60489178d7ac 100644 --- a/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java +++ b/junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ValueArgumentsProvider.java @@ -46,4 +46,5 @@ public void accept(ValueSource source) { public Stream 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 index 292aad1b59f4..9162e054fa5f 100644 --- 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 {}; }