[commons-numbers] branch master updated: Add return tag

[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


The following commit(s) were added to refs/heads/master by this push:
     new 2947203b Add return tag
2947203b is described below

commit 2947203b0023aafdbd6fcb83302a5346ac0ded7c
Author: aherbert <ah...@apache.org>
AuthorDate: Mon Oct 2 11:32:48 2023 +0100

    Add return tag
---
 .../src/main/java/org/apache/commons/numbers/core/DD.java            | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/DD.java b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/DD.java
index 7d84cee9..446916cd 100644
--- a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/DD.java
+++ b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/DD.java
@@ -2251,8 +2251,9 @@ public final class DD
      * numeric equality of different representations of zero as per {@code -0.0 == 0.0},
      * and equality of {@code NaN} values.
      *
-     * @param x Value.
-     * @param y Value.
+     * @param x Value
+     * @param y Value
+     * @return {@code true} if the values are numerically equal
      */
     private static boolean equals(double x, double y) {
         return Double.doubleToLongBits(x + 0.0) == Double.doubleToLongBits(y + 0.0);