From 49ca772ba6c6bf6ef7ea146ceda8dd54f287026e Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Fri, 15 Jul 2022 19:22:01 +0200 Subject: [PATCH] Polish Javadoc for @EnabledIf and @DisabledIf --- .../jupiter/api/condition/DisabledIf.java | 22 +++++++++---------- .../jupiter/api/condition/EnabledIf.java | 22 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/DisabledIf.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/DisabledIf.java index 8db9dd047a0a..56ef7a7fb194 100644 --- a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/DisabledIf.java +++ b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/DisabledIf.java @@ -22,12 +22,12 @@ import org.junit.jupiter.api.extension.ExtendWith; /** - * {@code @DisabledIf} is used to signal that the annotated test class or - * test method is disabled only if the provided condition - * evaluates to {@code true}. + * {@code @DisabledIf} is used to signal that the annotated test class or test + * method is disabled only if the provided + * {@linkplain #value() condition} evaluates to {@code true}. * - *

When applied at the class level, all test methods within that class - * will be disabled on the same condition. + *

When applied at the class level, all test methods within that class will + * be disabled on the same condition. * *

If a test method is disabled via this annotation, that does not prevent * the test class from being instantiated. Rather, it prevents the execution of @@ -71,14 +71,14 @@ public @interface DisabledIf { /** - * The name of a method within the test class or in external classes - * to use as a condition for the container's execution. + * The name of a method within the test class or in an external class to use + * as a condition for the test's or container's execution. * - *

Condition methods must be static if located outside the test class, - * or if {@code @DisabledIf} is used at class level. + *

Condition methods must be static if located outside the test class or + * if {@code @DisabledIf} is used at the class level. * - *

Condition methods in external classes must be referenced by fully - * qualified method name — for example, + *

A condition method in an external class must be referenced by its + * fully qualified method name — for example, * {@code com.example.Conditions#isEncryptionSupported}. */ String value(); diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/EnabledIf.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/EnabledIf.java index 1b7a84bd4f22..f4b9fa99249c 100644 --- a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/EnabledIf.java +++ b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/EnabledIf.java @@ -22,12 +22,12 @@ import org.junit.jupiter.api.extension.ExtendWith; /** - * {@code @EnabledIf} is used to signal that the annotated test class or - * test method is enabled only if the provided condition - * evaluates to {@code true}. + * {@code @EnabledIf} is used to signal that the annotated test class or test + * method is enabled only if the provided + * {@linkplain #value() condition} evaluates to {@code true}. * - *

When applied at the class level, all test methods within that class - * will be disabled on the same condition. + *

When applied at the class level, all test methods within that class will + * be enabled on the same condition. * *

If a test method is disabled via this annotation, that does not prevent * the test class from being instantiated. Rather, it prevents the execution of @@ -71,14 +71,14 @@ public @interface EnabledIf { /** - * The name of a method within the test class or in external classes - * to use as a condition for the container's execution. + * The name of a method within the test class or in an external class to use + * as a condition for the test's or container's execution. * - *

Condition methods must be static if located outside the test class, - * or if {@code @EnabledIf} is used at class level. + *

Condition methods must be static if located outside the test class or + * if {@code @EnabledIf} is used at the class level. * - *

Condition methods in external classes must be referenced by fully - * qualified method name — for example, + *

A condition method in an external class must be referenced by its + * fully qualified method name — for example, * {@code com.example.Conditions#isEncryptionSupported}. */ String value();