[commons-numbers] 05/08: Javadoc for trigonomic identities.

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git

commit f3a7bc914f4e7f62c92cbfca18f6faea68fb1f68
Author: aherbert <ah...@apache.org>
AuthorDate: Thu Dec 5 11:45:01 2019 +0000

    Javadoc for trigonomic identities.
---
 .../main/java/org/apache/commons/numbers/complex/Complex.java  | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
index 70ba899..aa169e5 100644
--- a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
+++ b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
@@ -1243,7 +1243,7 @@ public final class Complex implements Serializable  {
      * @param real Real part.
      * @param imaginary Imaginary part.
      * @param constructor Constructor.
-     * @return the hyperbolic cosine of this complex number
+     * @return the hyperbolic cosine of the complex number
      */
     private static Complex cosh(double real, double imaginary, ComplexConstructor constructor) {
         if (Double.isFinite(real)) {
@@ -1462,7 +1462,7 @@ public final class Complex implements Serializable  {
     public Complex sin() {
         // Define in terms of sinh
         // sin(z) = -i sinh(iz)
-        // Multiply this number by I, compute cosh, then multiply by back
+        // Multiply this number by I, compute sinh, then multiply by back
         return sinh(-imaginary, real, Complex::multiplyNegativeI);
     }
 
@@ -1493,7 +1493,7 @@ public final class Complex implements Serializable  {
      * @param real Real part.
      * @param imaginary Imaginary part.
      * @param constructor Constructor.
-     * @return the hyperbolic sine of this complex number
+     * @return the hyperbolic sine of the complex number
      */
     private static Complex sinh(double real, double imaginary, ComplexConstructor constructor) {
         if (Double.isFinite(real)) {
@@ -1611,7 +1611,7 @@ public final class Complex implements Serializable  {
     public Complex tan() {
         // Define in terms of tanh
         // tan(z) = -i tanh(iz)
-        // Multiply this number by I, compute cosh, then multiply by back
+        // Multiply this number by I, compute tanh, then multiply by back
         return tanh(-imaginary, real, Complex::multiplyNegativeI);
     }
 
@@ -1642,7 +1642,7 @@ public final class Complex implements Serializable  {
      * @param real Real part.
      * @param imaginary Imaginary part.
      * @param constructor Constructor.
-     * @return the hyperbolic tangent of this complex number
+     * @return the hyperbolic tangent of the complex number
      */
     private static Complex tanh(double real, double imaginary, ComplexConstructor constructor) {
         // TODO: Should these checks be made on real2 and imaginary2?