Skip to content

Commit

Permalink
Polish Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrannen committed Feb 4, 2025
1 parent fad9d56 commit 2fb0e22
Show file tree
Hide file tree
Showing 15 changed files with 24 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,7 @@ public interface ClassOrderer {
* <pre class="code">
* public void orderClasses(ClassOrdererContext context) {
* Collections.shuffle(context.getClassDescriptors());
* }
* </pre>
* }</pre>
*
* @param context the {@code ClassOrdererContext} containing the
* {@linkplain ClassDescriptor class descriptors} to order; never {@code null}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ public interface MethodOrderer {
* <pre class="code">
* public void orderMethods(MethodOrdererContext context) {
* Collections.shuffle(context.getMethodDescriptors());
* }
* </pre>
* }</pre>
*
* @param context the {@code MethodOrdererContext} containing the
* {@linkplain MethodDescriptor method descriptors} to order; never {@code null}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@
* class SecondaryTests {
* // {@literal @}Test methods ...
* }
* }
* </pre>
* }</pre>
*
* @since 5.8
* @see ClassOrderer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@ public interface TestInfo {
* class NestedTests {}
*
* static class StaticTests {}
* }
* </pre>
* }</pre>
*
* <p>If the context in which {@code TestInfo} is used is at the test level,
* the default display name is the name of the test method concatenated with
Expand All @@ -79,8 +78,7 @@ public interface TestInfo {
*
* <pre class="code">
* {@literal @}Test
* void testUser(TestInfo testInfo, {@literal @}Mock User user) {}
* </pre>
* void testUser(TestInfo testInfo, {@literal @}Mock User user) {}</pre>
*
* <p>Note that display names are typically used for test reporting in IDEs
* and build tools and may contain spaces, special characters, and even emoji.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@
* {@literal @}Test
* {@literal @}Order(3)
* void validValues() {}
* }
* </pre>
* }</pre>
*
* <h2>Parallel Execution</h2>
* <p>Using a {@link MethodOrderer} disables parallel execution unless the test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
*/

/**
* Defines JUnit Jupiter API for writing tests.
* Defines the JUnit Jupiter API for writing tests.
*
* @since 5.0
*/
module org.junit.jupiter.api {
requires static transitive org.apiguardian.api;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*/

/**
* Provides the JUnit Jupiter {@linkplain org.junit.platform.engine.TestEngine}
* Provides the JUnit Jupiter {@link org.junit.platform.engine.TestEngine}
* implementation.
*
* @since 5.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,7 @@ public static <T> Set<T> toSet(T[] values) {
* <pre class="code">
* public static &lt;T&gt; Collector&lt;T, ?, List&lt;T&gt;&gt; toUnmodifiableList(Supplier&lt;List&lt;T&gt;&gt; listSupplier) {
* return Collectors.collectingAndThen(Collectors.toCollection(listSupplier), Collections::unmodifiableList);
* }
* </pre>
* }</pre>
*
* @param <T> the type of the input elements
* @return a {@code Collector} which collects all the input elements into
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/**
* Public API for test engines.
*
* <p>Provides the {@linkplain org.junit.platform.engine.TestEngine} interface, test discovery
* and execution reporting support.
* <p>Provides the {@link org.junit.platform.engine.TestEngine} interface,
* test discovery, and execution reporting support.
*
* @since 1.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@
* )
* .configurationParameter("key1", "value1")
* .configurationParameters(configParameterMap)
* .build();
* </pre>
* .build();</pre>
*
* @since 1.0
* @see org.junit.platform.engine.discovery.DiscoverySelectors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
* Utility methods for dealing with legacy reporting infrastructure, such as
* reporting systems built on the Ant-based XML reporting format for JUnit 4.
*
* This class was formerly from {@code junit-platform-launcher}
* in {@link org.junit.platform.launcher.listeners} package.
* <p>This class was formerly from {@code junit-platform-launcher} in the
* {@link org.junit.platform.launcher.listeners} package.
*
* @since 1.0.3
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*/

/**
* Common support utilities for declarative test suite executors.
* Common support utilities for declarative test suites.
*
* @since 1.8
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
*/

/**
* Provides a {@linkplain org.junit.platform.engine.TestEngine} for running
* Provides a {@link org.junit.platform.engine.TestEngine} for running
* declarative test suites.
*
* @since 1.8
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ public static Event executionSkipped(TestDescriptor testDescriptor, String reaso
* Create a <em>started</em> {@code Event} for the supplied
* {@link TestDescriptor}.
*
* @param testDescriptor the {@code TestDescriptor} associated with the
* event; never {@code null}
* @param testDescriptor the {@code TestDescriptor} associated with the event;
* never {@code null}
* @return the newly created {@code Event}
* @see EventType#STARTED
*/
Expand All @@ -114,8 +114,8 @@ public static Event executionStarted(TestDescriptor testDescriptor) {
* Create a <em>finished</em> {@code Event} for the supplied
* {@link TestDescriptor} and {@link TestExecutionResult}.
*
* @param testDescriptor the {@code TestDescriptor} associated with the
* event; never {@code null}
* @param testDescriptor the {@code TestDescriptor} associated with the event;
* never {@code null}
* @param result the {@code TestExecutionResult} for the supplied
* {@code TestDescriptor}; never {@code null}
* @return the newly created {@code Event}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
*/

/**
* Provides a {@linkplain org.junit.platform.engine.TestEngine} for running
* JUnit 3 and 4 based tests on the platform.
* Provides a {@link org.junit.platform.engine.TestEngine} for running JUnit 3
* and 4 based tests on the platform.
*
* @since 4.12
* @provides org.junit.platform.engine.TestEngine The {@code VintageTestEngine}
Expand Down

0 comments on commit 2fb0e22

Please sign in to comment.