docs: fix return annotation tag in C comments

stdlib-js · Jul 14, 2024 · 26337e1 · 26337e1 · stdlib-bot · Jul 14, 2024
1 parent 8558d86
commit 26337e1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/lib/node_modules/@stdlib/math/base/special/acscd/src/main.c b/lib/node_modules/@stdlib/math/base/special/acscd/src/main.c
@@ -24,7 +24,7 @@
 * Computes the arccosecant (in degrees) of a double-precision floating-point number.
 *
 * @param x    input value
-* @returns    arccosecant (in degrees)
+* @return     arccosecant (in degrees)
 *
 * @example
 * double v = stdlib_base_acscd( 1.0 );

diff --git a/lib/node_modules/@stdlib/math/base/special/digamma/src/main.c b/lib/node_modules/@stdlib/math/base/special/digamma/src/main.c
@@ -111,7 +111,7 @@ static double rational_pq( const double x ) {
 * Evaluates the digamma function via asymptotic expansion.
 *
 * @param x    input value
-* @returns    function value
+* @return     function value
 */
 static double asymptoticApprox( const double x ) {
 	double y;
@@ -129,7 +129,7 @@ static double asymptoticApprox( const double x ) {
 * Evaluates the digamma function over interval `[1,2]`.
 *
 * @param x    input value
-* @returns    function value
+* @return     function value
 */
 static double rationalApprox( const double x ) {
 	double g;
@@ -211,7 +211,7 @@ static double rationalApprox( const double x ) {
 * -   Max error found: \\(2.452\mbox{e-}17\\) (double precision)
 *
 * @param x    input value
-* @returns    function value
+* @return     function value
 *
 * @example
 * double v = stdlib_base_digamma( -2.5 );

diff --git a/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c b/lib/node_modules/@stdlib/math/base/special/fast/atanh/src/main.c
@@ -26,7 +26,7 @@
 * Computes the hyperbolic arctangent of a number.
 *
 * @param x    input value
-* @returns    hyperbolic arctangent (in radians)
+* @return     hyperbolic arctangent (in radians)
 *
 * @example
 * double v = stdlib_base_fast_atanh( 0.0 );
Package	Statements	Branches	Functions	Lines
math/base/special/acscd	$\color{green}187/187$ $\color{green}+100.00\%$	$\color{green}5/5$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}187/187$ $\color{green}+100.00\%$
math/base/special/digamma	$\color{red}525/532$ $\color{green}+98.68\%$	$\color{red}32/35$ $\color{green}+91.43\%$	$\color{green}6/6$ $\color{green}+100.00\%$	$\color{red}525/532$ $\color{green}+98.68\%$
math/base/special/fast/atanh	$\color{green}186/186$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}186/186$ $\color{green}+100.00\%$