docs: update JSDoc comment formatting

Planeshifter · Planeshifter · commit 38a604780563 · 2023-07-27T10:39:53.000-04:00
diff --git a/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js b/lib/node_modules/@stdlib/math/base/ops/imul/lib/polyfill.js
@@ -91,7 +91,6 @@ var LOW_WORD_MASK = 0x0000ffff>>>0; // asm type annotation
 *
 * -   Lastly, the second term in the above equation contributes to the middle bits and may cause the product to "overflow". However, we can disregard (`>>>0`) overflow bits due to modulo arithmetic, as discussed earlier with regard to the term involving the partial product of high words.
 *
-*
 * @param {integer32} a - integer
 * @param {integer32} b - integer
 * @returns {integer32} product
diff --git a/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js b/lib/node_modules/@stdlib/math/base/ops/umul/lib/main.js
@@ -91,7 +91,6 @@ var LOW_WORD_MASK = 0x0000ffff>>>0; // asm type annotation
 *
 * -   Lastly, the second term in the above equation contributes to the middle bits and may cause the product to "overflow". However, we can disregard (`>>>0`) overflow bits due to modulo arithmetic, as discussed earlier with regard to the term involving the partial product of high words.
 *
-*
 * @param {uinteger32} a - integer
 * @param {uinteger32} b - integer
 * @returns {uinteger32} product
diff --git a/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cot/lib/main.js
@@ -26,31 +26,31 @@ var tan = require( '@stdlib/math/base/special/tan' );
 // MAIN //
 
 /**
- * Evaluates the cotangent of a number.
- *
- * @param {number} x - input value (in radians)
- * @returns {number} cotangent
- *
- * @example
- * var v = cot( 0.0 );
- * // returns Infinity
- *
- * @example
- * var v = cot( 3.141592653589793/2.0 );
- * // returns ~0.0
- *
- * @example
- * var v = cot( -3.141592653589793/4.0 );
- * // returns ~-1.0
- *
- * @example
- * var v = cot( 3.141592653589793/4.0 );
- * // returns ~1.0
- *
- * @example
- * var v = cot( NaN );
- * // returns NaN
- */
+* Evaluates the cotangent of a number.
+*
+* @param {number} x - input value (in radians)
+* @returns {number} cotangent
+*
+* @example
+* var v = cot( 0.0 );
+* // returns Infinity
+*
+* @example
+* var v = cot( 3.141592653589793/2.0 );
+* // returns ~0.0
+*
+* @example
+* var v = cot( -3.141592653589793/4.0 );
+* // returns ~-1.0
+*
+* @example
+* var v = cot( 3.141592653589793/4.0 );
+* // returns ~1.0
+*
+* @example
+* var v = cot( NaN );
+* // returns NaN
+*/
 function cot( x ) {
 	return 1.0 / tan( x );
 }
diff --git a/lib/node_modules/@stdlib/os/homedir/lib/index.js b/lib/node_modules/@stdlib/os/homedir/lib/index.js
@@ -38,7 +38,7 @@ var main = require( './main.js' );
 
 // VARIABLES //
 
-var home = ( isFunction( os.homedir ) ) ? os.homedir : main;
+var home = ( isFunction( os.homedir ) ) ? os.homedir : main; // eslint-disable-line node/no-unsupported-features/node-builtins
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mcovariance/lib/main.js
@@ -166,7 +166,6 @@ var format = require( '@stdlib/string/format' );
 *     C_n = C_{n-1} + \Delta x_{N,n-1} \Delta y_{N,n-1} - \Delta x_{0,n-1} \Delta y_{0,n-1} - \frac{(\Delta x_{N,n-1} - \Delta x_{0,n-1})(\Delta y_{N,n-1} - \Delta y_{0,n-1})}{N}
 *     ```
 *
-*
 * @param {PositiveInteger} W - window size
 * @param {number} [meanx] - mean value
 * @param {number} [meany] - mean value
diff --git a/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js b/lib/node_modules/@stdlib/stats/incr/meanstdev/lib/main.js
@@ -34,7 +34,6 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );
 * ## Method
 *
 
-*
 * -   This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let
 *
 *     ```tex
diff --git a/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js b/lib/node_modules/@stdlib/stats/incr/meanvar/lib/main.js
@@ -32,7 +32,6 @@ var format = require( '@stdlib/string/format' );
 *
 * ## Method
 *
-*
 * -   This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let
 *
 *     ```tex
diff --git a/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mpcorr/lib/main.js
@@ -242,7 +242,6 @@ var format = require( '@stdlib/string/format' );
 *
 *     where \\(\sigma_{x,n}\\) and \\(\sigma_{y,n}\\) are the corrected sample standard deviations for \\(x\\) and \\(y\\), respectively, for a window \\(n\\).
 *
-*
 * @param {PositiveInteger} W - window size
 * @param {number} [meanx] - mean value
 * @param {number} [meany] - mean value
diff --git a/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mpcorrdist/lib/main.js
@@ -41,7 +41,6 @@ var format = require( '@stdlib/string/format' );
 *
 * -   The implementation thus computes the sample Pearson product-moment correlation coefficient \\(r_n\\) for each window \\(n\\) and subtracts the coefficient from 1.
 *
-*
 * @param {PositiveInteger} W - window size
 * @param {number} [meanx] - mean value
 * @param {number} [meany] - mean value
diff --git a/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js
@@ -71,7 +71,6 @@ function product( workspace, acc, x ) {
 *
 * While intermediate results are largely immune to overflow and not subject to underflow, this does not mean that returned results will never be zero or infinite. In fact, zero (underflow) and infinite (overflow) results may be transient (i.e., infinity followed by a finite number).
 *
-*
 * ## References
 *
 * -   Ueberhuber, Christoph W. 1997. _Numerical Computation 1: Methods, Software, and Analysis_. Springer-Verlag Berlin Heidelberg. doi:[10.1007/978-3-642-59118-1](https://doi.org/10.1007/978-3-642-59118-1).
diff --git a/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/prod/lib/main.js
@@ -41,7 +41,6 @@ var PARTS = [ 0.0, 0 ];
 *
 * While intermediate results are largely immune to overflow and not subject to underflow, this does not mean that returned results will never be zero or infinite. In fact, zero (underflow) and infinite (overflow) results may be transient (i.e., infinity followed by a finite number).
 *
-*
 * ## References
 *
 * -   Ueberhuber, Christoph W. 1997. _Numerical Computation 1: Methods, Software, and Analysis_. Springer-Verlag Berlin Heidelberg. doi:[10.1007/978-3-642-59118-1](https://doi.org/10.1007/978-3-642-59118-1).
diff --git a/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js b/lib/node_modules/@stdlib/stats/incr/skewness/lib/main.js
@@ -40,7 +40,6 @@ var pow = require( '@stdlib/math/base/special/pow' );
 *
 * [@joanes:1998]: http://dx.doi.org/10.1111/1467-9884.00122
 *
-*
 * @returns {Function} accumulator function
 *
 * @example

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,6 @@ var LOW_WORD_MASK = 0x0000ffff>>>0; // asm type annotation`
`91`	`91`	`*`
`92`	`92`	* - Lastly, the second term in the above equation contributes to the middle bits and may cause the product to "overflow". However, we can disregard (`>>>0`) overflow bits due to modulo arithmetic, as discussed earlier with regard to the term involving the partial product of high words.
`93`	`93`	`*`
`94`		`-*`
`95`	`94`	`* @param {integer32} a - integer`
`96`	`95`	`* @param {integer32} b - integer`
`97`	`96`	`* @returns {integer32} product`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,6 @@ var format = require( '@stdlib/string/format' );`
`166`	`166`	`* C_n = C_{n-1} + \Delta x_{N,n-1} \Delta y_{N,n-1} - \Delta x_{0,n-1} \Delta y_{0,n-1} - \frac{(\Delta x_{N,n-1} - \Delta x_{0,n-1})(\Delta y_{N,n-1} - \Delta y_{0,n-1})}{N}`
`167`	`167`	* ```
`168`	`168`	`*`
`169`		`-*`
`170`	`169`	`* @param {PositiveInteger} W - window size`
`171`	`170`	`* @param {number} [meanx] - mean value`
`172`	`171`	`* @param {number} [meany] - mean value`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );`
`34`	`34`	`* ## Method`
`35`	`35`	`*`
`36`	`36`
`37`		`-*`
`38`	`37`	`* - This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let`
`39`	`38`	`*`
`40`	`39`	* ```tex
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ var format = require( '@stdlib/string/format' );`
`32`	`32`	`*`
`33`	`33`	`* ## Method`
`34`	`34`	`*`
`35`		`-*`
`36`	`35`	`* - This implementation uses Welford's algorithm for efficient computation, which can be derived as follows. Let`
`37`	`36`	`*`
`38`	`37`	* ```tex
Original file line number	Diff line number	Diff line change
`@@ -242,7 +242,6 @@ var format = require( '@stdlib/string/format' );`
`242`	`242`	`*`
`243`	`243`	`* where \\(\sigma_{x,n}\\) and \\(\sigma_{y,n}\\) are the corrected sample standard deviations for \\(x\\) and \\(y\\), respectively, for a window \\(n\\).`
`244`	`244`	`*`
`245`		`-*`
`246`	`245`	`* @param {PositiveInteger} W - window size`
`247`	`246`	`* @param {number} [meanx] - mean value`
`248`	`247`	`* @param {number} [meany] - mean value`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,6 @@ var format = require( '@stdlib/string/format' );`
`41`	`41`	`*`
`42`	`42`	`* - The implementation thus computes the sample Pearson product-moment correlation coefficient \\(r_n\\) for each window \\(n\\) and subtracts the coefficient from 1.`
`43`	`43`	`*`
`44`		`-*`
`45`	`44`	`* @param {PositiveInteger} W - window size`
`46`	`45`	`* @param {number} [meanx] - mean value`
`47`	`46`	`* @param {number} [meany] - mean value`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,6 @@ function product( workspace, acc, x ) {`
`71`	`71`	`*`
`72`	`72`	`* While intermediate results are largely immune to overflow and not subject to underflow, this does not mean that returned results will never be zero or infinite. In fact, zero (underflow) and infinite (overflow) results may be transient (i.e., infinity followed by a finite number).`
`73`	`73`	`*`
`74`		`-*`
`75`	`74`	`* ## References`
`76`	`75`	`*`
`77`	`76`	`* - Ueberhuber, Christoph W. 1997. _Numerical Computation 1: Methods, Software, and Analysis_. Springer-Verlag Berlin Heidelberg. doi:[10.1007/978-3-642-59118-1](https://doi.org/10.1007/978-3-642-59118-1).`