|
23 | 23 | * {@code @Testable} is used to signal to IDEs and tooling vendors that the
|
24 | 24 | * annotated or meta-annotated element is <em>testable</em>.
|
25 | 25 | *
|
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. |
29 | 29 | *
|
30 | 30 | * <h3>Motivation for {@code @Testable}</h3>
|
31 | 31 | * <p>Some clients of the JUnit Platform, notably IDEs such as IntelliJ IDEA,
|
32 | 32 | * operate only on sources for test discovery. Thus, they cannot use the full
|
33 | 33 | * runtime discovery mechanism of the JUnit Platform since it relies on compiled
|
34 | 34 | * 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. |
36 | 36 | *
|
37 | 37 | * <h3>Common Use Cases</h3>
|
38 | 38 | * <p>{@code @Testable} will typically be used as a meta-annotation in order to
|
|
66 | 66 | * is therefore required to discover tests based on information specific to
|
67 | 67 | * that test engine (e.g., annotations specific to that test engine).
|
68 | 68 | *
|
69 |
| - * <h3>{@code @Testable} may target any declaration element type</h3> |
| 69 | + * <h3>Supported Target Elements</h3> |
70 | 70 | * <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. |
73 | 73 | *
|
74 | 74 | * @since 1.0
|
75 | 75 | */
|
|
0 commit comments