Skip to content

Commit a962d5a

Browse files
committed
Polish Javadoc for @testable
See #2391
1 parent a245da0 commit a962d5a

File tree

1 file changed

+7
-7
lines changed
  • junit-platform-commons/src/main/java/org/junit/platform/commons/annotation

1 file changed

+7
-7
lines changed

junit-platform-commons/src/main/java/org/junit/platform/commons/annotation/Testable.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@
2323
* {@code @Testable} is used to signal to IDEs and tooling vendors that the
2424
* annotated or meta-annotated element is <em>testable</em>.
2525
*
26-
* <p>In this context, the term "testable" means that the annotated method, field,
27-
* or class can be executed by a {@code TestEngine} as a test or test container
28-
* on the JUnit Platform.
26+
* <p>In this context, the term "testable" means that the annotated element
27+
* (typically a method, field, or class) can be executed by a {@code TestEngine}
28+
* as a test or test container on the JUnit Platform.
2929
*
3030
* <h3>Motivation for {@code @Testable}</h3>
3131
* <p>Some clients of the JUnit Platform, notably IDEs such as IntelliJ IDEA,
3232
* operate only on sources for test discovery. Thus, they cannot use the full
3333
* runtime discovery mechanism of the JUnit Platform since it relies on compiled
3434
* classes. {@code @Testable} therefore serves as an alternative mechanism for
35-
* IDEs to discover tests by analyzing the source code only.
35+
* IDEs to discover potential tests by analyzing the source code only.
3636
*
3737
* <h3>Common Use Cases</h3>
3838
* <p>{@code @Testable} will typically be used as a meta-annotation in order to
@@ -66,10 +66,10 @@
6666
* is therefore required to discover tests based on information specific to
6767
* that test engine (e.g., annotations specific to that test engine).
6868
*
69-
* <h3>{@code @Testable} may target any declaration element type</h3>
69+
* <h3>Supported Target Elements</h3>
7070
* <p>Since JUnit Platform version 1.7, {@code @Testable} may target any
71-
* declaration {@linkplain java.lang.annotation.ElementType element type}.
72-
* That includes the aforementioned "method, field, or class" elements.
71+
* declaration {@linkplain java.lang.annotation.ElementType element type}. This
72+
* includes the aforementioned method, field, and class elements.
7373
*
7474
* @since 1.0
7575
*/

0 commit comments

Comments
 (0)