Skip to content

Commit 49ca772

Browse files
committed
Polish Javadoc for @EnabledIf and @DisabledIf
1 parent dafaabf commit 49ca772

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/DisabledIf.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
import org.junit.jupiter.api.extension.ExtendWith;
2323

2424
/**
25-
* {@code @DisabledIf} is used to signal that the annotated test class or
26-
* test method is <em>disabled</em> only if the provided condition
27-
* evaluates to {@code true}.
25+
* {@code @DisabledIf} is used to signal that the annotated test class or test
26+
* method is <em>disabled</em> only if the provided
27+
* {@linkplain #value() condition} evaluates to {@code true}.
2828
*
29-
* <p>When applied at the class level, all test methods within that class
30-
* will be disabled on the same condition.
29+
* <p>When applied at the class level, all test methods within that class will
30+
* be disabled on the same condition.
3131
*
3232
* <p>If a test method is disabled via this annotation, that does not prevent
3333
* the test class from being instantiated. Rather, it prevents the execution of
@@ -71,14 +71,14 @@
7171
public @interface DisabledIf {
7272

7373
/**
74-
* The name of a method within the test class or in external classes
75-
* to use as a condition for the container's execution.
74+
* The name of a method within the test class or in an external class to use
75+
* as a condition for the test's or container's execution.
7676
*
77-
* <p>Condition methods must be static if located outside the test class,
78-
* or if {@code @DisabledIf} is used at class level.
77+
* <p>Condition methods must be static if located outside the test class or
78+
* if {@code @DisabledIf} is used at the class level.
7979
*
80-
* <p>Condition methods in external classes must be referenced by <em>fully
81-
* qualified method name</em> &mdash; for example,
80+
* <p>A condition method in an external class must be referenced by its
81+
* <em>fully qualified method name</em> &mdash; for example,
8282
* {@code com.example.Conditions#isEncryptionSupported}.
8383
*/
8484
String value();

junit-jupiter-api/src/main/java/org/junit/jupiter/api/condition/EnabledIf.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@
2222
import org.junit.jupiter.api.extension.ExtendWith;
2323

2424
/**
25-
* {@code @EnabledIf} is used to signal that the annotated test class or
26-
* test method is <em>enabled</em> only if the provided condition
27-
* evaluates to {@code true}.
25+
* {@code @EnabledIf} is used to signal that the annotated test class or test
26+
* method is <em>enabled</em> only if the provided
27+
* {@linkplain #value() condition} evaluates to {@code true}.
2828
*
29-
* <p>When applied at the class level, all test methods within that class
30-
* will be disabled on the same condition.
29+
* <p>When applied at the class level, all test methods within that class will
30+
* be enabled on the same condition.
3131
*
3232
* <p>If a test method is disabled via this annotation, that does not prevent
3333
* the test class from being instantiated. Rather, it prevents the execution of
@@ -71,14 +71,14 @@
7171
public @interface EnabledIf {
7272

7373
/**
74-
* The name of a method within the test class or in external classes
75-
* to use as a condition for the container's execution.
74+
* The name of a method within the test class or in an external class to use
75+
* as a condition for the test's or container's execution.
7676
*
77-
* <p>Condition methods must be static if located outside the test class,
78-
* or if {@code @EnabledIf} is used at class level.
77+
* <p>Condition methods must be static if located outside the test class or
78+
* if {@code @EnabledIf} is used at the class level.
7979
*
80-
* <p>Condition methods in external classes must be referenced by <em>fully
81-
* qualified method name</em> &mdash; for example,
80+
* <p>A condition method in an external class must be referenced by its
81+
* <em>fully qualified method name</em> &mdash; for example,
8282
* {@code com.example.Conditions#isEncryptionSupported}.
8383
*/
8484
String value();

0 commit comments

Comments
 (0)