From 55092f6cc2a72eace79ebcf8d41f53bb3310e662 Mon Sep 17 00:00:00 2001
From: stdlib-bot <noreply@stdlib.io>
Date: Sun, 17 Mar 2024 00:42:55 +0000
Subject: [PATCH] Auto-generated commit

---
 .../is-negative-zero/benchmark/c/benchmark.c     |  2 +-
 .../is-negative-zerof/benchmark/c/benchmark.c    |  2 +-
 .../is-positive-zero/benchmark/c/benchmark.c     |  2 +-
 .../is-positive-zerof/benchmark/c/benchmark.c    |  2 +-
 base/special/acosd/src/main.c                    |  2 +-
 base/special/acotd/src/main.c                    |  2 +-
 base/special/asecd/src/main.c                    |  2 +-
 base/special/asind/src/main.c                    |  4 ++--
 base/special/bernoulli/src/main.c                |  2 +-
 base/special/cbrt/src/main.c                     |  2 +-
 base/special/csch/src/main.c                     | 16 ++++------------
 base/special/fast/acosh/src/main.c               |  2 +-
 base/special/fast/hypot/src/main.c               |  2 +-
 13 files changed, 17 insertions(+), 25 deletions(-)

diff --git a/base/assert/is-negative-zero/benchmark/c/benchmark.c b/base/assert/is-negative-zero/benchmark/c/benchmark.c
index f95162c5f..c52ce63a4 100644
--- a/base/assert/is-negative-zero/benchmark/c/benchmark.c
+++ b/base/assert/is-negative-zero/benchmark/c/benchmark.c
@@ -91,7 +91,7 @@ double rand_double() {
 * Tests if a numeric value is negative zero.
 *
 * @param x   value to test
-* @returns   boolean indicating if a numeric value is negative zero
+* @return    boolean indicating if a numeric value is negative zero
 */
 bool is_negative_zero( double x ) {
 	return ( 1.0/x == -HUGE_VAL );
diff --git a/base/assert/is-negative-zerof/benchmark/c/benchmark.c b/base/assert/is-negative-zerof/benchmark/c/benchmark.c
index f64d9d3ff..657ce23b2 100644
--- a/base/assert/is-negative-zerof/benchmark/c/benchmark.c
+++ b/base/assert/is-negative-zerof/benchmark/c/benchmark.c
@@ -91,7 +91,7 @@ float rand_float() {
 * Tests if a numeric value is negative zero.
 *
 * @param x   value to test
-* @returns   boolean indicating if a numeric value is negative zero
+* @return    boolean indicating if a numeric value is negative zero
 */
 bool is_negative_zerof( float x ) {
 	return ( x == 0.0f && 1.0f/x == -INFINITY );
diff --git a/base/assert/is-positive-zero/benchmark/c/benchmark.c b/base/assert/is-positive-zero/benchmark/c/benchmark.c
index 84dcc9592..1d50781a3 100644
--- a/base/assert/is-positive-zero/benchmark/c/benchmark.c
+++ b/base/assert/is-positive-zero/benchmark/c/benchmark.c
@@ -91,7 +91,7 @@ double rand_double() {
 * Tests if a numeric value is positive zero.
 *
 * @param x   value to test
-* @returns   boolean indicating if a numeric value is positive zero
+* @return    boolean indicating if a numeric value is positive zero
 */
 bool is_positive_zero( double x ) {
 	return ( 1.0/x == HUGE_VAL );
diff --git a/base/assert/is-positive-zerof/benchmark/c/benchmark.c b/base/assert/is-positive-zerof/benchmark/c/benchmark.c
index 05a5be75d..40af4a863 100644
--- a/base/assert/is-positive-zerof/benchmark/c/benchmark.c
+++ b/base/assert/is-positive-zerof/benchmark/c/benchmark.c
@@ -91,7 +91,7 @@ float rand_float() {
 * Tests if a numeric value is positive zero.
 *
 * @param x   value to test
-* @returns   boolean indicating if a numeric value is positive zero
+* @return    boolean indicating if a numeric value is positive zero
 */
 bool is_positive_zerof( float x ) {
 	return ( x == 0.0f && 1.0f/x == INFINITY );
diff --git a/base/special/acosd/src/main.c b/base/special/acosd/src/main.c
index 0f2c5f08c..d9572ccca 100644
--- a/base/special/acosd/src/main.c
+++ b/base/special/acosd/src/main.c
@@ -24,7 +24,7 @@
 * Computes the arccosine (in degrees) of a double-precision floating-point number.
 *
 * @param x    input value
-* @returns    arccosine (in degrees)
+* @return     arccosine (in degrees)
 *
 * @example
 * double v = stdlib_base_acosd( 0.0 );
diff --git a/base/special/acotd/src/main.c b/base/special/acotd/src/main.c
index b76dfcbe5..f1c29a2d0 100644
--- a/base/special/acotd/src/main.c
+++ b/base/special/acotd/src/main.c
@@ -24,7 +24,7 @@
 * Computes the arccotangent (in degrees) of a double-precision floating-point number.
 *
 * @param x    input value
-* @returns    arccotangent (in degrees)
+* @return     arccotangent (in degrees)
 *
 * @example
 * double v = stdlib_base_acotd( 0.0 );
diff --git a/base/special/asecd/src/main.c b/base/special/asecd/src/main.c
index 8c121b481..6a758d8e6 100644
--- a/base/special/asecd/src/main.c
+++ b/base/special/asecd/src/main.c
@@ -24,7 +24,7 @@
 * Computes the arcsecant (in degrees) of a double-precision floating-point number.
 *
 * @param x    input value
-* @returns    arcsecant (in degrees)
+* @return     arcsecant (in degrees)
 *
 * @example
 * double v = stdlib_base_asecd( 1.0 );
diff --git a/base/special/asind/src/main.c b/base/special/asind/src/main.c
index cfd337746..52c1b6e47 100644
--- a/base/special/asind/src/main.c
+++ b/base/special/asind/src/main.c
@@ -23,8 +23,8 @@
 /**
 * Computes the arcsine (in degrees) of a double-precision floating-point number.
 *
-* @param x - input value
-* @returns arcsine (in degrees)
+* @param x    input value
+* @return     arcsine (in degrees)
 *
 * @example
 * double v = stdlib_base_acotd( 0.0 );
diff --git a/base/special/bernoulli/src/main.c b/base/special/bernoulli/src/main.c
index 22e851dcc..576e74d7b 100644
--- a/base/special/bernoulli/src/main.c
+++ b/base/special/bernoulli/src/main.c
@@ -163,7 +163,7 @@ int32_t MAX_BERNOULLI = 258;
 * Computes the nth Bernoulli number.
 *
 * @param n    input value
-* @returns    output value
+* @return     output value
 *
 * @example
 * double out = stdlib_base_bernoulli( 0 );
diff --git a/base/special/cbrt/src/main.c b/base/special/cbrt/src/main.c
index 41e2185d9..8d9a9efab 100644
--- a/base/special/cbrt/src/main.c
+++ b/base/special/cbrt/src/main.c
@@ -58,7 +58,7 @@ static const double P4 = 0.145996192886612446982;  // 0x3fc2b000, 0xd4e4edd7
 * [horners-method]: https://en.wikipedia.org/wiki/Horner%27s_method
 *
 * @param x    value at which to evaluate the polynomial
-* @returns    evaluated polynomial
+* @return     evaluated polynomial
 */
 static double polval( const double x ) {
 	if ( x == 0.0 ) {
diff --git a/base/special/csch/src/main.c b/base/special/csch/src/main.c
index 545e664d1..a12dd98b7 100644
--- a/base/special/csch/src/main.c
+++ b/base/special/csch/src/main.c
@@ -22,24 +22,16 @@
 /**
 * Computes the hyperbolic cosecant of a number.
 *
-* @param {number} x - input value
-* @returns {number} hyperbolic cosecant
+* @param x    input value
+* @return     hyperbolic cosecant
 *
 * @example
-* var v = csch( 0.0 );
-* // returns Infinity
-*
-* @example
-* var v = csch( 2.0 );
+* var v = stdlib_base_csch( 2.0 );
 * // returns ~0.2757
 *
 * @example
-* var v = csch( -2.0 );
+* var v = stdlib_base_csch( -2.0 );
 * // returns ~-0.2757
-*
-* @example
-* var v = csch( NaN );
-* // returns NaN
 */
 double stdlib_base_csch( const double x ) {
     return 1.0 / stdlib_base_sinh( x );
diff --git a/base/special/fast/acosh/src/main.c b/base/special/fast/acosh/src/main.c
index 788f0f0f8..aadb31e8e 100644
--- a/base/special/fast/acosh/src/main.c
+++ b/base/special/fast/acosh/src/main.c
@@ -27,7 +27,7 @@
 * Computes the hyperbolic arccosine of a number.
 *
 * @param x    input value
-* @returns    hyperbolic arccosine (in radians)
+* @return     hyperbolic arccosine (in radians)
 *
 * @example
 * double v = stdlib_base_fast_acosh( 1.0 );
diff --git a/base/special/fast/hypot/src/main.c b/base/special/fast/hypot/src/main.c
index 9287e11e2..1ec015d48 100644
--- a/base/special/fast/hypot/src/main.c
+++ b/base/special/fast/hypot/src/main.c
@@ -24,7 +24,7 @@
 *
 * @param x    number
 * @param y    number
-* @returns    hypotenuse
+* @return     hypotenuse
 *
 * @example
 * double h = stdlib_base_fast_hypot( -5.0, 12.0 );