Merge pull request #2650 from tevans78/fixJavaDoc

juherr · web-flow · commit f93a9dcb9664 · 2021-10-05T20:09:47.000+02:00
Fix JavaDoc as code throws AssertionError not AssertionFailedError
diff --git a/testng-asserts/src/main/java/org/testng/Assert.java b/testng-asserts/src/main/java/org/testng/Assert.java
@@ -878,7 +878,7 @@ public static void assertEquals(byte actual, byte expected) {
   }
 
   /**
-   * Asserts that two chars are equal. If they are not, an AssertionFailedError, with the given
+   * Asserts that two chars are equal. If they are not, an AssertionError, with the given
    * message, is thrown.
    *
    * @param actual the actual value
@@ -900,7 +900,7 @@ public static void assertEquals(char actual, char expected) {
   }
 
   /**
-   * Asserts that two shorts are equal. If they are not, an AssertionFailedError, with the given
+   * Asserts that two shorts are equal. If they are not, an AssertionError, with the given
    * message, is thrown.
    *
    * @param actual the actual value
@@ -922,7 +922,7 @@ public static void assertEquals(short actual, short expected) {
   }
 
   /**
-   * Asserts that two ints are equal. If they are not, an AssertionFailedError, with the given
+   * Asserts that two ints are equal. If they are not, an AssertionError, with the given
    * message, is thrown.
    *
    * @param actual the actual value
@@ -953,7 +953,7 @@ public static void assertNotNull(Object object) {
   }
 
   /**
-   * Asserts that an object isn't null. If it is, an AssertionFailedError, with the given message,
+   * Asserts that an object isn't null. If it is, an AssertionError, with the given message,
    * is thrown.
    *
    * @param object the assertion object
@@ -980,7 +980,7 @@ public static void assertNull(Object object) {
   }
 
   /**
-   * Asserts that an object is null. If it is not, an AssertionFailedError, with the given message,
+   * Asserts that an object is null. If it is not, an AssertionError, with the given message,
    * is thrown.
    *
    * @param object the assertion object
@@ -993,7 +993,7 @@ public static void assertNull(Object object, String message) {
   }
 
   /**
-   * Asserts that two objects refer to the same object. If they do not, an AssertionFailedError,
+   * Asserts that two objects refer to the same object. If they do not, an AssertionError,
    * with the given message, is thrown.
    *
    * @param actual the actual value
diff --git a/testng-core/src/main/java/org/testng/AssertJUnit.java b/testng-core/src/main/java/org/testng/AssertJUnit.java
@@ -12,7 +12,7 @@ public class AssertJUnit extends ArrayAsserts {
   protected AssertJUnit() {}
 
   /**
-   * Asserts that a condition is true. If it isn't it throws an AssertionFailedError with the given
+   * Asserts that a condition is true. If it isn't it throws an AssertionError with the given
    * message.
    *
    * @param message The message
@@ -25,7 +25,7 @@ public static void assertTrue(String message, boolean condition) {
   }
 
   /**
-   * Asserts that a condition is true. If it isn't it throws an AssertionFailedError.
+   * Asserts that a condition is true. If it isn't it throws an AssertionError.
    *
    * @param condition The actual condition
    */
@@ -34,7 +34,7 @@ public static void assertTrue(boolean condition) {
   }
 
   /**
-   * Asserts that a condition is false. If it isn't it throws an AssertionFailedError with the given
+   * Asserts that a condition is false. If it isn't it throws an AssertionError with the given
    * message.
    *
    * @param message The message
@@ -45,7 +45,7 @@ public static void assertFalse(String message, boolean condition) {
   }
 
   /**
-   * Asserts that a condition is false. If it isn't it throws an AssertionFailedError.
+   * Asserts that a condition is false. If it isn't it throws an AssertionError.
    *
    * @param condition The actual condition
    */
@@ -71,7 +71,7 @@ public static void fail() {
   }
 
   /**
-   * Asserts that two objects are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two objects are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -89,7 +89,7 @@ public static void assertEquals(String message, Object expected, Object actual)
   }
 
   /**
-   * Asserts that two objects are equal. If they are not an AssertionFailedError is thrown.
+   * Asserts that two objects are equal. If they are not an AssertionError is thrown.
    *
    * @param expected The expected value
    * @param actual The actual value
@@ -126,7 +126,7 @@ public static void assertEquals(String expected, String actual) {
   }
 
   /**
-   * Asserts that two doubles are equal concerning a delta. If they are not an AssertionFailedError
+   * Asserts that two doubles are equal concerning a delta. If they are not an AssertionError
    * is thrown with the given message. If the expected value is infinity then the delta value is
    * ignored.
    *
@@ -162,7 +162,7 @@ public static void assertEquals(double expected, double actual, double delta) {
   }
 
   /**
-   * Asserts that two floats are equal concerning a delta. If they are not an AssertionFailedError
+   * Asserts that two floats are equal concerning a delta. If they are not an AssertionError
    * is thrown with the given message. If the expected value is infinity then the delta value is
    * ignored.
    *
@@ -197,7 +197,7 @@ public static void assertEquals(float expected, float actual, float delta) {
   }
 
   /**
-   * Asserts that two longs are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two longs are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -219,7 +219,7 @@ public static void assertEquals(long expected, long actual) {
   }
 
   /**
-   * Asserts that two booleans are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two booleans are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -241,7 +241,7 @@ public static void assertEquals(boolean expected, boolean actual) {
   }
 
   /**
-   * Asserts that two bytes are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two bytes are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -263,7 +263,7 @@ public static void assertEquals(byte expected, byte actual) {
   }
 
   /**
-   * Asserts that two chars are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two chars are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -285,7 +285,7 @@ public static void assertEquals(char expected, char actual) {
   }
 
   /**
-   * Asserts that two shorts are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two shorts are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -307,7 +307,7 @@ public static void assertEquals(short expected, short actual) {
   }
 
   /**
-   * Asserts that two ints are equal. If they are not an AssertionFailedError is thrown with the
+   * Asserts that two ints are equal. If they are not an AssertionError is thrown with the
    * given message.
    *
    * @param message The message
@@ -338,7 +338,7 @@ public static void assertNotNull(Object object) {
   }
 
   /**
-   * Asserts that an object isn't null. If it is an AssertionFailedError is thrown with the given
+   * Asserts that an object isn't null. If it is an AssertionError is thrown with the given
    * message.
    *
    * @param message The message
@@ -358,7 +358,7 @@ public static void assertNull(Object object) {
   }
 
   /**
-   * Asserts that an object is null. If it is not an AssertionFailedError is thrown with the given
+   * Asserts that an object is null. If it is not an AssertionError is thrown with the given
    * message.
    *
    * @param message The message
@@ -369,7 +369,7 @@ public static void assertNull(String message, Object object) {
   }
 
   /**
-   * Asserts that two objects refer to the same object. If they are not an AssertionFailedError is
+   * Asserts that two objects refer to the same object. If they are not an AssertionError is
    * thrown with the given message.
    *
    * @param message The message
@@ -385,7 +385,7 @@ public static void assertSame(String message, Object expected, Object actual) {
 
   /**
    * Asserts that two objects refer to the same object. If they are not the same an
-   * AssertionFailedError is thrown.
+   * AssertionError is thrown.
    *
    * @param expected The expected value
    * @param actual The actual value
@@ -395,7 +395,7 @@ public static void assertSame(Object expected, Object actual) {
   }
 
   /**
-   * Asserts that two objects refer to the same object. If they are not an AssertionFailedError is
+   * Asserts that two objects refer to the same object. If they are not an AssertionError is
    * thrown with the given message.
    *
    * @param message The message
@@ -410,7 +410,7 @@ public static void assertNotSame(String message, Object expected, Object actual)
 
   /**
    * Asserts that two objects refer to the same object. If they are not the same an
-   * AssertionFailedError is thrown.
+   * AssertionError is thrown.
    *
    * @param expected The expected value
    * @param actual The actual value

Original file line number	Diff line number	Diff line change
`@@ -878,7 +878,7 @@ public static void assertEquals(byte actual, byte expected) {`
`878`	`878`	`}`
`879`	`879`
`880`	`880`	`/**`
`881`		`- * Asserts that two chars are equal. If they are not, an AssertionFailedError, with the given`
	`881`	`+ * Asserts that two chars are equal. If they are not, an AssertionError, with the given`
`882`	`882`	`* message, is thrown.`
`883`	`883`	`*`
`884`	`884`	`* @param actual the actual value`
`@@ -900,7 +900,7 @@ public static void assertEquals(char actual, char expected) {`
`900`	`900`	`}`
`901`	`901`
`902`	`902`	`/**`
`903`		`- * Asserts that two shorts are equal. If they are not, an AssertionFailedError, with the given`
	`903`	`+ * Asserts that two shorts are equal. If they are not, an AssertionError, with the given`
`904`	`904`	`* message, is thrown.`
`905`	`905`	`*`
`906`	`906`	`* @param actual the actual value`
`@@ -922,7 +922,7 @@ public static void assertEquals(short actual, short expected) {`
`922`	`922`	`}`
`923`	`923`
`924`	`924`	`/**`
`925`		`- * Asserts that two ints are equal. If they are not, an AssertionFailedError, with the given`
	`925`	`+ * Asserts that two ints are equal. If they are not, an AssertionError, with the given`
`926`	`926`	`* message, is thrown.`
`927`	`927`	`*`
`928`	`928`	`* @param actual the actual value`
`@@ -953,7 +953,7 @@ public static void assertNotNull(Object object) {`
`953`	`953`	`}`
`954`	`954`
`955`	`955`	`/**`
`956`		`- * Asserts that an object isn't null. If it is, an AssertionFailedError, with the given message,`
	`956`	`+ * Asserts that an object isn't null. If it is, an AssertionError, with the given message,`
`957`	`957`	`* is thrown.`
`958`	`958`	`*`
`959`	`959`	`* @param object the assertion object`
`@@ -980,7 +980,7 @@ public static void assertNull(Object object) {`
`980`	`980`	`}`
`981`	`981`
`982`	`982`	`/**`
`983`		`- * Asserts that an object is null. If it is not, an AssertionFailedError, with the given message,`
	`983`	`+ * Asserts that an object is null. If it is not, an AssertionError, with the given message,`
`984`	`984`	`* is thrown.`
`985`	`985`	`*`
`986`	`986`	`* @param object the assertion object`
`@@ -993,7 +993,7 @@ public static void assertNull(Object object, String message) {`
`993`	`993`	`}`
`994`	`994`
`995`	`995`	`/**`
`996`		`- * Asserts that two objects refer to the same object. If they do not, an AssertionFailedError,`
	`996`	`+ * Asserts that two objects refer to the same object. If they do not, an AssertionError,`
`997`	`997`	`* with the given message, is thrown.`
`998`	`998`	`*`
`999`	`999`	`* @param actual the actual value`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public class AssertJUnit extends ArrayAsserts {`
`12`	`12`	`protected AssertJUnit() {}`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * Asserts that a condition is true. If it isn't it throws an AssertionFailedError with the given`
	`15`	`+ * Asserts that a condition is true. If it isn't it throws an AssertionError with the given`
`16`	`16`	`* message.`
`17`	`17`	`*`
`18`	`18`	`* @param message The message`
`@@ -25,7 +25,7 @@ public static void assertTrue(String message, boolean condition) {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`/**`
`28`		`- * Asserts that a condition is true. If it isn't it throws an AssertionFailedError.`
	`28`	`+ * Asserts that a condition is true. If it isn't it throws an AssertionError.`
`29`	`29`	`*`
`30`	`30`	`* @param condition The actual condition`
`31`	`31`	`*/`
`@@ -34,7 +34,7 @@ public static void assertTrue(boolean condition) {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Asserts that a condition is false. If it isn't it throws an AssertionFailedError with the given`
	`37`	`+ * Asserts that a condition is false. If it isn't it throws an AssertionError with the given`
`38`	`38`	`* message.`
`39`	`39`	`*`
`40`	`40`	`* @param message The message`
`@@ -45,7 +45,7 @@ public static void assertFalse(String message, boolean condition) {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`/**`
`48`		`- * Asserts that a condition is false. If it isn't it throws an AssertionFailedError.`
	`48`	`+ * Asserts that a condition is false. If it isn't it throws an AssertionError.`
`49`	`49`	`*`
`50`	`50`	`* @param condition The actual condition`
`51`	`51`	`*/`
`@@ -71,7 +71,7 @@ public static void fail() {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`/**`
`74`		`- * Asserts that two objects are equal. If they are not an AssertionFailedError is thrown with the`
	`74`	`+ * Asserts that two objects are equal. If they are not an AssertionError is thrown with the`
`75`	`75`	`* given message.`
`76`	`76`	`*`
`77`	`77`	`* @param message The message`
`@@ -89,7 +89,7 @@ public static void assertEquals(String message, Object expected, Object actual)`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`/**`
`92`		`- * Asserts that two objects are equal. If they are not an AssertionFailedError is thrown.`
	`92`	`+ * Asserts that two objects are equal. If they are not an AssertionError is thrown.`
`93`	`93`	`*`
`94`	`94`	`* @param expected The expected value`
`95`	`95`	`* @param actual The actual value`
`@@ -126,7 +126,7 @@ public static void assertEquals(String expected, String actual) {`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`/**`
`129`		`- * Asserts that two doubles are equal concerning a delta. If they are not an AssertionFailedError`
	`129`	`+ * Asserts that two doubles are equal concerning a delta. If they are not an AssertionError`
`130`	`130`	`* is thrown with the given message. If the expected value is infinity then the delta value is`
`131`	`131`	`* ignored.`
`132`	`132`	`*`
`@@ -162,7 +162,7 @@ public static void assertEquals(double expected, double actual, double delta) {`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`/**`
`165`		`- * Asserts that two floats are equal concerning a delta. If they are not an AssertionFailedError`
	`165`	`+ * Asserts that two floats are equal concerning a delta. If they are not an AssertionError`
`166`	`166`	`* is thrown with the given message. If the expected value is infinity then the delta value is`
`167`	`167`	`* ignored.`
`168`	`168`	`*`
`@@ -197,7 +197,7 @@ public static void assertEquals(float expected, float actual, float delta) {`
`197`	`197`	`}`
`198`	`198`
`199`	`199`	`/**`
`200`		`- * Asserts that two longs are equal. If they are not an AssertionFailedError is thrown with the`
	`200`	`+ * Asserts that two longs are equal. If they are not an AssertionError is thrown with the`
`201`	`201`	`* given message.`
`202`	`202`	`*`
`203`	`203`	`* @param message The message`
`@@ -219,7 +219,7 @@ public static void assertEquals(long expected, long actual) {`
`219`	`219`	`}`
`220`	`220`
`221`	`221`	`/**`
`222`		`- * Asserts that two booleans are equal. If they are not an AssertionFailedError is thrown with the`
	`222`	`+ * Asserts that two booleans are equal. If they are not an AssertionError is thrown with the`
`223`	`223`	`* given message.`
`224`	`224`	`*`
`225`	`225`	`* @param message The message`
`@@ -241,7 +241,7 @@ public static void assertEquals(boolean expected, boolean actual) {`
`241`	`241`	`}`
`242`	`242`
`243`	`243`	`/**`
`244`		`- * Asserts that two bytes are equal. If they are not an AssertionFailedError is thrown with the`
	`244`	`+ * Asserts that two bytes are equal. If they are not an AssertionError is thrown with the`
`245`	`245`	`* given message.`
`246`	`246`	`*`
`247`	`247`	`* @param message The message`
`@@ -263,7 +263,7 @@ public static void assertEquals(byte expected, byte actual) {`
`263`	`263`	`}`
`264`	`264`
`265`	`265`	`/**`
`266`		`- * Asserts that two chars are equal. If they are not an AssertionFailedError is thrown with the`
	`266`	`+ * Asserts that two chars are equal. If they are not an AssertionError is thrown with the`
`267`	`267`	`* given message.`
`268`	`268`	`*`
`269`	`269`	`* @param message The message`
`@@ -285,7 +285,7 @@ public static void assertEquals(char expected, char actual) {`
`285`	`285`	`}`
`286`	`286`
`287`	`287`	`/**`
`288`		`- * Asserts that two shorts are equal. If they are not an AssertionFailedError is thrown with the`
	`288`	`+ * Asserts that two shorts are equal. If they are not an AssertionError is thrown with the`
`289`	`289`	`* given message.`
`290`	`290`	`*`
`291`	`291`	`* @param message The message`
`@@ -307,7 +307,7 @@ public static void assertEquals(short expected, short actual) {`
`307`	`307`	`}`
`308`	`308`
`309`	`309`	`/**`
`310`		`- * Asserts that two ints are equal. If they are not an AssertionFailedError is thrown with the`
	`310`	`+ * Asserts that two ints are equal. If they are not an AssertionError is thrown with the`
`311`	`311`	`* given message.`
`312`	`312`	`*`
`313`	`313`	`* @param message The message`
`@@ -338,7 +338,7 @@ public static void assertNotNull(Object object) {`
`338`	`338`	`}`
`339`	`339`
`340`	`340`	`/**`
`341`		`- * Asserts that an object isn't null. If it is an AssertionFailedError is thrown with the given`
	`341`	`+ * Asserts that an object isn't null. If it is an AssertionError is thrown with the given`
`342`	`342`	`* message.`
`343`	`343`	`*`
`344`	`344`	`* @param message The message`
`@@ -358,7 +358,7 @@ public static void assertNull(Object object) {`
`358`	`358`	`}`
`359`	`359`
`360`	`360`	`/**`
`361`		`- * Asserts that an object is null. If it is not an AssertionFailedError is thrown with the given`
	`361`	`+ * Asserts that an object is null. If it is not an AssertionError is thrown with the given`
`362`	`362`	`* message.`
`363`	`363`	`*`
`364`	`364`	`* @param message The message`
`@@ -369,7 +369,7 @@ public static void assertNull(String message, Object object) {`
`369`	`369`	`}`
`370`	`370`
`371`	`371`	`/**`
`372`		`- * Asserts that two objects refer to the same object. If they are not an AssertionFailedError is`
	`372`	`+ * Asserts that two objects refer to the same object. If they are not an AssertionError is`
`373`	`373`	`* thrown with the given message.`
`374`	`374`	`*`
`375`	`375`	`* @param message The message`
`@@ -385,7 +385,7 @@ public static void assertSame(String message, Object expected, Object actual) {`
`385`	`385`
`386`	`386`	`/**`
`387`	`387`	`* Asserts that two objects refer to the same object. If they are not the same an`
`388`		`- * AssertionFailedError is thrown.`
	`388`	`+ * AssertionError is thrown.`
`389`	`389`	`*`
`390`	`390`	`* @param expected The expected value`
`391`	`391`	`* @param actual The actual value`
`@@ -395,7 +395,7 @@ public static void assertSame(Object expected, Object actual) {`
`395`	`395`	`}`
`396`	`396`
`397`	`397`	`/**`
`398`		`- * Asserts that two objects refer to the same object. If they are not an AssertionFailedError is`
	`398`	`+ * Asserts that two objects refer to the same object. If they are not an AssertionError is`
`399`	`399`	`* thrown with the given message.`
`400`	`400`	`*`
`401`	`401`	`* @param message The message`
`@@ -410,7 +410,7 @@ public static void assertNotSame(String message, Object expected, Object actual)`
`410`	`410`
`411`	`411`	`/**`
`412`	`412`	`* Asserts that two objects refer to the same object. If they are not the same an`
`413`		`- * AssertionFailedError is thrown.`
	`413`	`+ * AssertionError is thrown.`
`414`	`414`	`*`
`415`	`415`	`* @param expected The expected value`
`416`	`416`	`* @param actual The actual value`