Skip to content

Commit 22af4a2

Browse files
committed
Improve wording and formatting in Javadoc
1 parent 434f4bb commit 22af4a2

File tree

20 files changed

+27
-28
lines changed

20 files changed

+27
-28
lines changed

junit-jupiter-api/src/main/java/org/junit/jupiter/api/ClassTemplate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
*
4747
* <h2>Inheritance</h2>
4848
*
49-
* <p>This annotation is inherited by subclasses.
49+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
5050
*
5151
* @since 5.13
5252
* @see TestTemplate @TestTemplate

junit-jupiter-params/src/main/java/org/junit/jupiter/params/ParameterizedClass.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@
124124
*
125125
* <h2>Inheritance</h2>
126126
*
127-
* <p>This annotation is inherited by subclasses.
127+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
128128
*
129129
* @since 5.13
130130
* @see Parameter

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ArgumentsSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
*
3434
* <h2>Inheritance</h2>
3535
*
36-
* <p>This annotation is inherited to subclasses.
36+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
3737
*
3838
* @since 5.0
3939
* @see org.junit.jupiter.params.provider.ArgumentsProvider

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/ArgumentsSources.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424
/**
2525
* {@code @ArgumentsSources} is a simple container for one or more
26-
* {@link ArgumentsSource} annotations.
26+
* {@link ArgumentsSource @ArgumentsSource} annotations.
2727
*
2828
* <p>Note, however, that use of the {@code @ArgumentsSources} container is completely
2929
* optional since {@code @ArgumentsSource} is a {@linkplain java.lang.annotation.Repeatable
3030
* repeatable} annotation.
3131
*
3232
* <h2>Inheritance</h2>
3333
*
34-
* <p>This annotation is inherited to subclasses.
34+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
3535
*
3636
* @since 5.0
3737
* @see org.junit.jupiter.params.provider.ArgumentsSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvFileSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
*
7171
* <h2>Inheritance</h2>
7272
*
73-
* <p>This annotation is inherited to subclasses.
73+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
7474
*
7575
* @since 5.0
7676
* @see CsvSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvFileSources.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424
/**
2525
* {@code @CsvFileSources} is a simple container for one or more
26-
* {@link CsvFileSource} annotations.
26+
* {@link CsvFileSource @CsvFileSource} annotations.
2727
*
2828
* <p>Note, however, that use of the {@code @CsvFileSources} container is completely
2929
* optional since {@code @CsvFileSource} is a {@linkplain java.lang.annotation.Repeatable
3030
* repeatable} annotation.
3131
*
3232
* <h2>Inheritance</h2>
3333
*
34-
* <p>This annotation is inherited to subclasses.
34+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
3535
*
3636
* @since 5.11
3737
* @see CsvFileSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
*
7676
* <h2>Inheritance</h2>
7777
*
78-
* <p>This annotation is inherited to subclasses.
78+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
7979
*
8080
* @since 5.0
8181
* @see CsvFileSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/CsvSources.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424
/**
2525
* {@code @CsvSources} is a simple container for one or more
26-
* {@link CsvSource} annotations.
26+
* {@link CsvSource @CsvSource} annotations.
2727
*
2828
* <p>Note, however, that use of the {@code @CsvSources} container is completely
2929
* optional since {@code @CsvSource} is a {@linkplain java.lang.annotation.Repeatable
3030
* repeatable} annotation.
3131
*
3232
* <h2>Inheritance</h2>
3333
*
34-
* <p>This annotation is inherited to subclasses.
34+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
3535
*
3636
* @since 5.11
3737
* @see CsvSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/EmptySource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
*
4848
* <h2>Inheritance</h2>
4949
*
50-
* <p>This annotation is inherited to subclasses.
50+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
5151
*
5252
* @since 5.4
5353
* @see org.junit.jupiter.params.provider.ArgumentsSource

junit-jupiter-params/src/main/java/org/junit/jupiter/params/provider/EnumSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
*
4747
* <h2>Inheritance</h2>
4848
*
49-
* <p>This annotation is inherited to subclasses.
49+
* <p>This annotation is {@linkplain Inherited inherited} within class hierarchies.
5050
*
5151
* @since 5.0
5252
* @see org.junit.jupiter.params.provider.ArgumentsSource

0 commit comments

Comments
 (0)