Skip to content

Commit 2fb0e22

Browse files
committed
Polish Javadoc
1 parent fad9d56 commit 2fb0e22

File tree

15 files changed

+24
-30
lines changed

15 files changed

+24
-30
lines changed

junit-jupiter-api/src/main/java/org/junit/jupiter/api/ClassOrderer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ public interface ClassOrderer {
9090
* <pre class="code">
9191
* public void orderClasses(ClassOrdererContext context) {
9292
* Collections.shuffle(context.getClassDescriptors());
93-
* }
94-
* </pre>
93+
* }</pre>
9594
*
9695
* @param context the {@code ClassOrdererContext} containing the
9796
* {@linkplain ClassDescriptor class descriptors} to order; never {@code null}

junit-jupiter-api/src/main/java/org/junit/jupiter/api/MethodOrderer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,7 @@ public interface MethodOrderer {
8888
* <pre class="code">
8989
* public void orderMethods(MethodOrdererContext context) {
9090
* Collections.shuffle(context.getMethodDescriptors());
91-
* }
92-
* </pre>
91+
* }</pre>
9392
*
9493
* @param context the {@code MethodOrdererContext} containing the
9594
* {@linkplain MethodDescriptor method descriptors} to order; never {@code null}

junit-jupiter-api/src/main/java/org/junit/jupiter/api/TestClassOrder.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@
5757
* class SecondaryTests {
5858
* // {@literal @}Test methods ...
5959
* }
60-
* }
61-
* </pre>
60+
* }</pre>
6261
*
6362
* @since 5.8
6463
* @see ClassOrderer

junit-jupiter-api/src/main/java/org/junit/jupiter/api/TestInfo.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ public interface TestInfo {
6868
* class NestedTests {}
6969
*
7070
* static class StaticTests {}
71-
* }
72-
* </pre>
71+
* }</pre>
7372
*
7473
* <p>If the context in which {@code TestInfo} is used is at the test level,
7574
* the default display name is the name of the test method concatenated with
@@ -79,8 +78,7 @@ public interface TestInfo {
7978
*
8079
* <pre class="code">
8180
* {@literal @}Test
82-
* void testUser(TestInfo testInfo, {@literal @}Mock User user) {}
83-
* </pre>
81+
* void testUser(TestInfo testInfo, {@literal @}Mock User user) {}</pre>
8482
*
8583
* <p>Note that display names are typically used for test reporting in IDEs
8684
* and build tools and may contain spaces, special characters, and even emoji.

junit-jupiter-api/src/main/java/org/junit/jupiter/api/TestMethodOrder.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@
6262
* {@literal @}Test
6363
* {@literal @}Order(3)
6464
* void validValues() {}
65-
* }
66-
* </pre>
65+
* }</pre>
6766
*
6867
* <h2>Parallel Execution</h2>
6968
* <p>Using a {@link MethodOrderer} disables parallel execution unless the test

junit-jupiter-api/src/module/org.junit.jupiter.api/module-info.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
*/
1010

1111
/**
12-
* Defines JUnit Jupiter API for writing tests.
12+
* Defines the JUnit Jupiter API for writing tests.
13+
*
14+
* @since 5.0
1315
*/
1416
module org.junit.jupiter.api {
1517
requires static transitive org.apiguardian.api;

junit-jupiter-engine/src/module/org.junit.jupiter.engine/module-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*/
1010

1111
/**
12-
* Provides the JUnit Jupiter {@linkplain org.junit.platform.engine.TestEngine}
12+
* Provides the JUnit Jupiter {@link org.junit.platform.engine.TestEngine}
1313
* implementation.
1414
*
1515
* @since 5.0

junit-platform-commons/src/main/java/org/junit/platform/commons/util/CollectionUtils.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,7 @@ public static <T> Set<T> toSet(T[] values) {
126126
* <pre class="code">
127127
* public static &lt;T&gt; Collector&lt;T, ?, List&lt;T&gt;&gt; toUnmodifiableList(Supplier&lt;List&lt;T&gt;&gt; listSupplier) {
128128
* return Collectors.collectingAndThen(Collectors.toCollection(listSupplier), Collections::unmodifiableList);
129-
* }
130-
* </pre>
129+
* }</pre>
131130
*
132131
* @param <T> the type of the input elements
133132
* @return a {@code Collector} which collects all the input elements into

junit-platform-engine/src/module/org.junit.platform.engine/module-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
/**
1212
* Public API for test engines.
1313
*
14-
* <p>Provides the {@linkplain org.junit.platform.engine.TestEngine} interface, test discovery
15-
* and execution reporting support.
14+
* <p>Provides the {@link org.junit.platform.engine.TestEngine} interface,
15+
* test discovery, and execution reporting support.
1616
*
1717
* @since 1.0
1818
*/

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/LauncherDiscoveryRequestBuilder.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,7 @@
7878
* )
7979
* .configurationParameter("key1", "value1")
8080
* .configurationParameters(configParameterMap)
81-
* .build();
82-
* </pre>
81+
* .build();</pre>
8382
*
8483
* @since 1.0
8584
* @see org.junit.platform.engine.discovery.DiscoverySelectors

0 commit comments

Comments
 (0)