Correct JavaDoc for QuadJUnitTests.java

m-vokhm · Feb 28, 2021 · c8f50a9 · c8f50a9
1 parent 8042759
commit c8f50a9
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 63 deletions.
diff --git a/test/com/mvohm/quadruple/test/QuadJUnitTests.java b/test/com/mvohm/quadruple/test/QuadJUnitTests.java
@@ -37,8 +37,8 @@
 public class QuadJUnitTests {
 
   /**
-   * Prepares the environment. Sets the medium level of verbosity
-   * and sets {@link java.util.Locale#US} as the default locale, to provide formatting
+   * Prepares the testing environment.<br>
+   * Sets the medium level of verbosity and sets {@link java.util.Locale#US} as the default locale, to provide formatting
    * of numbers in such a way that they can be parsed by methods like {@link Double#valueOf(String)}
    */
   @Before
@@ -48,8 +48,8 @@ public void setup() {
   }
 
   /**
-   * Tests {@link Quadruple#toString()} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#toString()} method.<br>
+   * Creates an instance of {@link QuadToStringTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -65,8 +65,8 @@ public void testQuadToStringConversion() {
   } // public void testQuadToStringConversion() {
 
   /**
-   * Tests {@link Quadruple#doubleValue()} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#doubleValue()} method.<br>
+   * Creates an instance of {@link QuadToDoubleTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -82,8 +82,8 @@ public void testQuadToDoubleConversion() {
   } // public void testQuadToDoubleConversion() {
 
   /**
-   * Tests {@link Quadruple#longValue()} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#longValue()} method.<br>
+   * Creates an instance of {@link QuadToLongTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -99,8 +99,8 @@ public void testQuadToLongConversion() {
   } // public void testQuadToLongConversion() {
 
   /**
-   * Tests {@link Quadruple#intValue()} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#intValue()} method.<br>
+   * Creates an instance of {@link QuadToIntTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -116,8 +116,8 @@ public void testQuadToIntConversion() {
   } // public void testQuadToIntConversion() {
 
   /**
-   * Tests {@link Quadruple#bigDecimalValue()} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#bigDecimalValue()} method.<br>
+   * Creates an instance of {@link QuadToBdTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -133,8 +133,8 @@ public void testQuadToBdConversion() {
   } // public void testQuadToBdConversion() {
 
   /**
-   * Tests {@link Quadruple#Quadruple(String)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#Quadruple(String)} method.<br>
+   * Creates an instance of {@link StringToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -150,8 +150,8 @@ public void testStringToQuadConversion() {
   } // public void testStringToQuadConversion() {
 
   /**
-   * Tests {@link Quadruple#Quadruple(BigDecimal)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#Quadruple(BigDecimal)} method.<br>
+   * Creates an instance of {@link BdToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -167,8 +167,8 @@ public void testBdToQuadConversion() {
   } // public void testBdToQuadConversion() {
 
   /**
-   * Tests {@link Quadruple#Quadruple(double)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#Quadruple(double)} method.<br>
+   * Creates an instance of {@link DoubleToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -184,8 +184,8 @@ public void testDoubleToQuadConversion() {
   } // public void testDoubleToQuadConversion() {
 
   /**
-   * Tests {@link Quadruple#Quadruple(long)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#Quadruple(long)} method.<br>
+   * Creates an instance of {@link LongToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -201,8 +201,8 @@ public void testLongToQuadConversion() {
   } //public void testLongToQuadConversion() {
 
   /**
-   * Tests {@link Quadruple#add(Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#add(Quadruple)} method.<br>
+   * Creates an instance of {@link InstanceAdditionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -218,8 +218,8 @@ public void testInstanceAddition() {
   } // public void testInstanceAddition() {
 
   /**
-   * Tests {@link Quadruple#subtract(Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#subtract(Quadruple)} method.<br>
+   * Creates an instance of {@link InstanceSubtractionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -235,8 +235,8 @@ public void testInstanceSubtraction() {
   } // public void testInstanceSubtraction() {
 
   /**
-   * Tests {@link Quadruple#multiply(Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#multiply(Quadruple)} method.<br>
+   * Creates an instance of {@link InstanceMultiplicationTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -252,8 +252,8 @@ public void testInstanceMultiplication() {
   } // public void testInstanceMultiplication() {
 
   /**
-   * Tests {@link Quadruple#divide(Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#divide(Quadruple)} method.<br>
+   * Creates an instance of {@link InstanceDivisionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -269,8 +269,8 @@ public void testInstanceDivision() {
   } // public void testInstanceDivision() {
 
   /**
-   * Tests {@link Quadruple#add(Quadruple, Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#add(Quadruple, Quadruple)} method.<br>
+   * Creates an instance of {@link StaticAdditionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -286,8 +286,8 @@ public void testStaticAddition() {
   } // public void testStaticAddition() {
 
   /**
-   * Tests {@link Quadruple#subtract(Quadruple, Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#subtract(Quadruple, Quadruple)} method.<br>
+   * Creates an instance of {@link StaticSubtractionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -303,8 +303,8 @@ public void testStaticSubtraction() {
   } // public void testStaticSubtraction() {
 
   /**
-   * Tests {@link Quadruple#multiply(Quadruple, Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#multiply(Quadruple, Quadruple)} method.<br>
+   * Creates an instance of {@link StaticMultiplicationTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -320,9 +320,8 @@ public void testStaticMultiplication() {
   } // public void testStaticMultiplication() {
 
   /**
-   * Tests {@link Quadruple#divide(Quadruple, Quadruple)}
-   * method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#divide(Quadruple, Quadruple)}method.<br>
+   * Creates an instance of {@link StaticDivisionTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -339,8 +338,8 @@ public void testStaticDivision() {
 
   /**
    * Tests {@code Quadruple -> String -> Quadruple} conversion that is expected
-   * to return the exact original value.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * to return the exact original value.<br>
+   * Creates an instance of {@link QuadToStringToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -357,8 +356,8 @@ public void testQuadToStringToQuad() {
 
   /**
    * Tests {@code Quadruple -> BigDecimal -> Quadruple} conversion
-   * that is expected to return the exact original value.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * that is expected to return the exact original value.<br>
+   * Creates an instance of {@link QuadToBDToQuadTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -374,8 +373,8 @@ public void testQuadToBDToQuad() {
   } // public void testQuadToBDToQuad() {
 
   /**
-   * Tests {@link Quadruple#sqrt(Quadruple)} method.
-   * Creates the appropriate tester, calls its {@link QuadTester#test()} method,
+   * Tests {@link Quadruple#sqrt(Quadruple)} method.<br>
+   * Creates an instance of {@link StaticSqrtTester}, calls its {@link QuadTester#test()} method,
    * and verifies that the {@link TestResults} instance returned by it
    * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
@@ -391,7 +390,10 @@ public void testStaticSqrt() {
   } // public void testStaticSqrt() {
 
   /**
-   * Tests instance {@link Quadruple#sqrt() method }
+   * Tests instance {@link Quadruple#sqrt()} method.<br>
+   * Creates an instance of {@link InstanceSqrtTester}, calls its {@link QuadTester#test()} method,
+   * and verifies that the {@link TestResults} instance returned by it
+   * does not indicate errors exceeding {@link QuadTest#NORM_ERR_THRESH}.
    */
   @Test
   public void testInstanceSqrt() {

diff --git a/test/doc/allclasses-frame.html b/test/doc/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>All Classes</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/test/doc/allclasses-noframe.html b/test/doc/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>All Classes</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/test/doc/constant-values.html b/test/doc/constant-values.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>Constant Field Values</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/test/doc/deprecated-list.html b/test/doc/deprecated-list.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>Deprecated List</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/test/doc/help-doc.html b/test/doc/help-doc.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>API Help</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/test/doc/index-all.html b/test/doc/index-all.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>Index</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -1391,7 +1391,7 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/QuadJUnitTests.html#setup--">setup()</a></span> - Method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/QuadJUnitTests.html" title="class in com.mvohm.quadruple.test">QuadJUnitTests</a></dt>
 <dd>
-<div class="block">Prepares the environment.</div>
+<div class="block">Prepares the testing environment.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/TesterClasses.html#setVerbosity-com.mvohm.quadruple.test.TesterClasses.Verbosity-">setVerbosity(TesterClasses.Verbosity)</a></span> - Static method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/TesterClasses.html" title="class in com.mvohm.quadruple.test">TesterClasses</a></dt>
 <dd>
@@ -1682,7 +1682,7 @@ <h2 class="title">T</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/QuadJUnitTests.html#testInstanceSqrt--">testInstanceSqrt()</a></span> - Method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/QuadJUnitTests.html" title="class in com.mvohm.quadruple.test">QuadJUnitTests</a></dt>
 <dd>
-<div class="block">Tests instance <a href="file:/F:/git/Quadruple_GH2/doc/com/mvohm/quadruple/Quadruple.html?is-external=true#sqrt--" title="class or interface in com.mvohm.quadruple"><code>method </code></a></div>
+<div class="block">Tests instance <a href="file:/F:/git/Quadruple_GH2/doc/com/mvohm/quadruple/Quadruple.html?is-external=true#sqrt--" title="class or interface in com.mvohm.quadruple"><code>Quadruple.sqrt()</code></a> method.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/QuadJUnitTests.html#testInstanceSubtraction--">testInstanceSubtraction()</a></span> - Method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/QuadJUnitTests.html" title="class in com.mvohm.quadruple.test">QuadJUnitTests</a></dt>
 <dd>
@@ -1762,8 +1762,7 @@ <h2 class="title">T</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/QuadJUnitTests.html#testStaticDivision--">testStaticDivision()</a></span> - Method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/QuadJUnitTests.html" title="class in com.mvohm.quadruple.test">QuadJUnitTests</a></dt>
 <dd>
-<div class="block">Tests <a href="file:/F:/git/Quadruple_GH2/doc/com/mvohm/quadruple/Quadruple.html?is-external=true#divide-com.mvohm.quadruple.Quadruple-com.mvohm.quadruple.Quadruple-" title="class or interface in com.mvohm.quadruple"><code>Quadruple.divide(Quadruple, Quadruple)</code></a>
- method.</div>
+<div class="block">Tests <a href="file:/F:/git/Quadruple_GH2/doc/com/mvohm/quadruple/Quadruple.html?is-external=true#divide-com.mvohm.quadruple.Quadruple-com.mvohm.quadruple.Quadruple-" title="class or interface in com.mvohm.quadruple"><code>Quadruple.divide(Quadruple, Quadruple)</code></a>method.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="com/mvohm/quadruple/test/QuadJUnitTests.html#testStaticMultiplication--">testStaticMultiplication()</a></span> - Method in class com.mvohm.quadruple.test.<a href="com/mvohm/quadruple/test/QuadJUnitTests.html" title="class in com.mvohm.quadruple.test">QuadJUnitTests</a></dt>
 <dd>

diff --git a/test/doc/index.html b/test/doc/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>Generated Documentation (Untitled)</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;

diff --git a/test/doc/overview-tree.html b/test/doc/overview-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="ru">
 <head>
-<!-- Generated by javadoc (1.8.0_211) on Sat Feb 27 20:43:59 GMT+05:00 2021 -->
+<!-- Generated by javadoc (1.8.0_211) on Sun Feb 28 12:25:42 GMT+05:00 2021 -->
 <title>Class Hierarchy</title>
-<meta name="date" content="2021-02-27">
+<meta name="date" content="2021-02-28">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>