Skip to content

Commit a5d87ff

Browse files
committed
Polish Javadoc for @IfProfileValue
1 parent 412f74f commit a5d87ff

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.java

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,32 +27,33 @@
2727
* <p>
2828
* Test annotation to indicate that a test is enabled for a specific testing
2929
* profile or environment. If the configured {@link ProfileValueSource} returns
30-
* a matching {@link #value() value} for the provided {@link #name() name}, the
31-
* test will be enabled.
30+
* a matching {@link #value} for the provided {@link #name}, the test will be
31+
* enabled.
3232
* </p>
3333
* <p>
34-
* Note: {@code &#064;IfProfileValue} can be applied at the class level,
35-
* the method level, or both. {@code &#064;IfProfileValue} at the class
36-
* level overrides method-level usage of {@code &#064;IfProfileValue} for
37-
* any methods within that class.
34+
* Note: {@code @IfProfileValue} can be applied at the class level, the method
35+
* level, or both. {@code @IfProfileValue} at the class level overrides
36+
* method-level usage of {@code @IfProfileValue} for any methods within that
37+
* class.
3838
* </p>
39+
*
40+
* <h3>Examples</h3>
3941
* <p>
40-
* Examples: when using {@link SystemProfileValueSource} as the
41-
* {@link ProfileValueSource} implementation, you can configure a test method to
42-
* run only on Java VMs from Sun Microsystems as follows:
42+
* When using {@link SystemProfileValueSource} as the {@link ProfileValueSource}
43+
* implementation, you can configure a test method to run only on Java VMs from
44+
* Sun Microsystems as follows:
4345
* </p>
44-
*
4546
* <pre class="code">
4647
* &#064;IfProfileValue(name = &quot;java.vendor&quot;, value = &quot;Sun Microsystems Inc.&quot;)
4748
* public void testSomething() {
4849
* // ...
4950
* }
5051
* </pre>
5152
* <p>
52-
* You can alternatively configure {@code &#064;IfProfileValue} with
53-
* <em>OR</em> semantics for multiple {@link #values() values} as follows
54-
* (assuming a {@link ProfileValueSource} has been appropriately configured for
55-
* the &quot;test-groups&quot; name):
53+
* You can alternatively configure {@code @IfProfileValue} with <em>OR</em>
54+
* semantics for multiple {@link #values() values} as follows (assuming a
55+
* {@link ProfileValueSource} has been appropriately configured for the
56+
* &quot;test-groups&quot; name):
5657
* </p>
5758
*
5859
* <pre class="code">

0 commit comments

Comments
 (0)