#2914: improve grammar and markup in javadoc according to review

mmerdes · mmerdes · commit 07b4f51ec141 · 2022-07-04T09:33:25.000+02:00
diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/AfterAll.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/AfterAll.java
@@ -43,17 +43,16 @@
  * <h2>Inheritance and Execution Order</h2>
  *
  * <p>{@code @AfterAll} methods are inherited from superclasses as long as
- * they are not <em>hidden</em> (default mode with {@code static} modifier) or
- * <em>overridden</em> or 'superseded' (i.e., replaced based on signature only,
- * irrespective of Java's visibility rules). Furthermore, {@code @AfterAll}
- * methods from superclasses will be executed after {@code @AfterAll} methods
- * in subclasses.
+ * they are not <em>hidden</em> (default mode with {@code static} modifier), or
+ * <em>overridden</em>, or <em>superseded</em> (i.e., replaced based on
+ * signature only, irrespective of Java's visibility rules). Furthermore,
+ * {@code @AfterAll} methods from superclasses will be executed before
+ * {@code @AfterAll} methods in subclasses.
  *
  * <p>Similarly, {@code @AfterAll} methods declared in an interface are
- * inherited as long as they are not <em>hidden</em> or <em>overridden</em>
- * (or 'superseded', see above), and {@code @AfterAll} methods from an
- * interface will be executed after {@code @AfterAll} methods in the class
- * that implements the interface.
+ * inherited as long as they are not <em>hidden</em> or <em>overridden</em>,
+ * and {@code @AfterAll} methods from an interface will be executed after
+ * {@code @AfterAll} methods in the class that implements the interface.
  *
  * <p>JUnit Jupiter does not guarantee the execution order of multiple
  * {@code @AfterAll} methods that are declared within a single test class or
diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/AfterEach.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/AfterEach.java
@@ -36,8 +36,8 @@
  * <h2>Inheritance and Execution Order</h2>
  *
  * <p>{@code @AfterEach} methods are inherited from superclasses as long as
- * they are not overridden  or 'superseded' (i.e., replaced based on signature
- * only, irrespective of Java's visibility rules). Furthermore,
+ * they are not overridden or <em>superseded</em> (i.e., replaced based on
+ * signature only, irrespective of Java's visibility rules). Furthermore,
  * {@code @AfterEach} methods from superclasses will be executed after
  * {@code @AfterEach} methods in subclasses.
  *
diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/BeforeAll.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/BeforeAll.java
@@ -43,17 +43,16 @@
  * <h2>Inheritance and Execution Order</h2>
  *
  * <p>{@code @BeforeAll} methods are inherited from superclasses as long as
- * they are not <em>hidden</em> (default mode with {@code static} modifier) or
- * <em>overridden</em> or 'superseded' (i.e., replaced based on signature only,
- * irrespective of Java's visibility rules). Furthermore, {@code @BeforeAll}
- * methods from superclasses will be executed before {@code @BeforeAll} methods
- * in subclasses.
+ * they are not <em>hidden</em> (default mode with {@code static} modifier), or
+ * <em>overridden</em>, or <em>superseded</em> (i.e., replaced based on
+ * signature only, irrespective of Java's visibility rules). Furthermore,
+ * {@code @BeforeAll} methods from superclasses will be executed before
+ * {@code @BeforeAll} methods in subclasses.
  *
  * <p>Similarly, {@code @BeforeAll} methods declared in an interface are
- * inherited as long as they are not <em>hidden</em> or <em>overridden</em>
- * (or 'superseded', see above), and {@code @BeforeAll} methods from an
- * interface will be executed before {@code @BeforeAll} methods in the class
- * that implements the interface.
+ * inherited as long as they are not <em>hidden</em> or <em>overridden</em>,
+ * and {@code @BeforeAll} methods from an interface will be executed before
+ * {@code @BeforeAll} methods in the class that implements the interface.
  *
  * <p>JUnit Jupiter does not guarantee the execution order of multiple
  * {@code @BeforeAll} methods that are declared within a single test class or
diff --git a/junit-jupiter-api/src/main/java/org/junit/jupiter/api/BeforeEach.java b/junit-jupiter-api/src/main/java/org/junit/jupiter/api/BeforeEach.java
@@ -36,8 +36,8 @@
  * <h2>Inheritance and Execution Order</h2>
  *
  * <p>{@code @BeforeEach} methods are inherited from superclasses as long as
- * they are not overridden  or 'superseded' (i.e., replaced based on signature
- * only, irrespective of Java's visibility rules). Furthermore,
+ * they are not overridden or <em>superseded</em> (i.e., replaced based on
+ * signature only, irrespective of Java's visibility rules). Furthermore,
  * {@code @BeforeEach} methods from superclasses will be executed before
  * {@code @BeforeEach} methods in subclasses.
  *

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,8 @@`
`36`	`36`	`* <h2>Inheritance and Execution Order</h2>`
`37`	`37`	`*`
`38`	`38`	`* <p>{@code @AfterEach} methods are inherited from superclasses as long as`
`39`		`- * they are not overridden or 'superseded' (i.e., replaced based on signature`
`40`		`- * only, irrespective of Java's visibility rules). Furthermore,`
	`39`	`+ * they are not overridden or <em>superseded</em> (i.e., replaced based on`
	`40`	`+ * signature only, irrespective of Java's visibility rules). Furthermore,`
`41`	`41`	`* {@code @AfterEach} methods from superclasses will be executed after`
`42`	`42`	`* {@code @AfterEach} methods in subclasses.`
`43`	`43`	`*`