diff --git a/junit-platform-commons/src/main/java/org/junit/platform/commons/annotation/Testable.java b/junit-platform-commons/src/main/java/org/junit/platform/commons/annotation/Testable.java index 7305646c91b5..4a0f2315be97 100644 --- a/junit-platform-commons/src/main/java/org/junit/platform/commons/annotation/Testable.java +++ b/junit-platform-commons/src/main/java/org/junit/platform/commons/annotation/Testable.java @@ -23,16 +23,16 @@ * {@code @Testable} is used to signal to IDEs and tooling vendors that the * annotated or meta-annotated element is testable. * - *
In this context, the term "testable" means that the annotated method, field, - * or class can be executed by a {@code TestEngine} as a test or test container - * on the JUnit Platform. + *
In this context, the term "testable" means that the annotated element + * (typically a method, field, or class) can be executed by a {@code TestEngine} + * as a test or test container on the JUnit Platform. * *
Some clients of the JUnit Platform, notably IDEs such as IntelliJ IDEA, * operate only on sources for test discovery. Thus, they cannot use the full * runtime discovery mechanism of the JUnit Platform since it relies on compiled * classes. {@code @Testable} therefore serves as an alternative mechanism for - * IDEs to discover tests by analyzing the source code only. + * IDEs to discover potential tests by analyzing the source code only. * *
{@code @Testable} will typically be used as a meta-annotation in order to @@ -66,10 +66,10 @@ * is therefore required to discover tests based on information specific to * that test engine (e.g., annotations specific to that test engine). * - *
Since JUnit Platform version 1.7, {@code @Testable} may target any - * declaration {@linkplain java.lang.annotation.ElementType element type}. - * That includes the aforementioned "method, field, or class" elements. + * declaration {@linkplain java.lang.annotation.ElementType element type}. This + * includes the aforementioned method, field, and class elements. * * @since 1.0 */