Skip to content

Commit dbc55f9

Browse files
committed
docs: add JSDoc example tags
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent e341eb5 commit dbc55f9

File tree

9 files changed

+39
-0
lines changed

9 files changed

+39
-0
lines changed

lib/node_modules/@stdlib/math/base/special/besselj0/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,19 @@
2828
* var v = j0( 0.0 );
2929
* // returns 1.0
3030
*
31+
* @example
3132
* v = j0( 1.0 );
3233
* // returns ~0.765
3334
*
35+
* @example
3436
* v = j0( Infinity );
3537
* // returns 0.0
3638
*
39+
* @example
3740
* v = j0( -Infinity );
3841
* // returns 0.0
3942
*
43+
* @example
4044
* v = j0( NaN );
4145
* // returns NaN
4246
*/

lib/node_modules/@stdlib/math/base/special/besselj0/lib/main.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,19 @@ var sc = [ 0.0, 0.0 ];
6868
* var v = j0( 0.0 );
6969
* // returns 1.0
7070
*
71+
* @example
7172
* v = j0( 1.0 );
7273
* // returns ~0.765
7374
*
75+
* @example
7476
* v = j0( Infinity );
7577
* // returns 0.0
7678
*
79+
* @example
7780
* v = j0( -Infinity );
7881
* // returns 0.0
7982
*
83+
* @example
8084
* v = j0( NaN );
8185
* // returns NaN
8286
*/

lib/node_modules/@stdlib/math/base/special/besselj0/lib/native.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,19 @@ var addon = require( './../src/addon.node' );
3636
* var v = j0( 0.0 );
3737
* // returns 1.0
3838
*
39+
* @example
3940
* v = j0( 1.0 );
4041
* // returns ~0.765
4142
*
43+
* @example
4244
* v = j0( Infinity );
4345
* // returns 0.0
4446
*
47+
* @example
4548
* v = j0( -Infinity );
4649
* // returns 0.0
4750
*
51+
* @example
4852
* v = j0( NaN );
4953
* // returns NaN
5054
*/

lib/node_modules/@stdlib/math/base/special/besselj1/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,19 @@
3232
* var v = j1( 0.0 );
3333
* // returns 0.0
3434
*
35+
* @example
3536
* v = j1( 1.0 );
3637
* // returns ~0.440
3738
*
39+
* @example
3840
* v = j1( Infinity );
3941
* // returns 0.0
4042
*
43+
* @example
4144
* v = j1( -Infinity );
4245
* // returns 0.0
4346
*
47+
* @example
4448
* v = j1( NaN );
4549
* // returns NaN
4650
*/

lib/node_modules/@stdlib/math/base/special/besselj1/lib/main.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,19 @@ var sc = [ 0.0, 0.0 ];
7373
* var v = j1( 0.0 );
7474
* // returns 0.0
7575
*
76+
* @example
7677
* v = j1( 1.0 );
7778
* // returns ~0.440
7879
*
80+
* @example
7981
* v = j1( Infinity );
8082
* // returns 0.0
8183
*
84+
* @example
8285
* v = j1( -Infinity );
8386
* // returns 0.0
8487
*
88+
* @example
8589
* v = j1( NaN );
8690
* // returns NaN
8791
*/

lib/node_modules/@stdlib/math/base/special/besselj1/lib/native.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,19 @@ var addon = require( './../src/addon.node' );
3333
* var v = j1( 0.0 );
3434
* // returns 0.0
3535
*
36+
* @example
3637
* v = j1( 1.0 );
3738
* // returns ~0.440
3839
*
40+
* @example
3941
* v = j1( Infinity );
4042
* // returns 0.0
4143
*
44+
* @example
4245
* v = j1( -Infinity );
4346
* // returns 0.0
4447
*
48+
* @example
4549
* v = j1( NaN );
4650
* // returns NaN
4751
*/

lib/node_modules/@stdlib/math/base/special/bessely0/docs/types/index.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,23 @@
3232
* var v = y0( 0.0 );
3333
* // returns -Infinity
3434
*
35+
* @example
3536
* v = y0( 1.0 );
3637
* // returns ~0.088
3738
*
39+
* @example
3840
* v = y0( -1.0 );
3941
* // returns NaN
4042
*
43+
* @example
4144
* v = y0( Infinity );
4245
* // returns 0.0
4346
*
47+
* @example
4448
* v = y0( -Infinity );
4549
* // returns NaN
4650
*
51+
* @example
4752
* v = y0( NaN );
4853
* // returns NaN
4954
*/

lib/node_modules/@stdlib/math/base/special/bessely0/lib/main.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,23 @@ var sc = [ 0.0, 0.0 ];
8383
* var v = y0( 0.0 );
8484
* // returns -Infinity
8585
*
86+
* @example
8687
* v = y0( 1.0 );
8788
* // returns ~0.088
8889
*
90+
* @example
8991
* v = y0( -1.0 );
9092
* // returns NaN
9193
*
94+
* @example
9295
* v = y0( Infinity );
9396
* // returns 0.0
9497
*
98+
* @example
9599
* v = y0( -Infinity );
96100
* // returns NaN
97101
*
102+
* @example
98103
* v = y0( NaN );
99104
* // returns NaN
100105
*/

lib/node_modules/@stdlib/math/base/special/bessely0/lib/native.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,23 @@ var addon = require( './../src/addon.node' );
3636
* var v = y0( 0.0 );
3737
* // returns -Infinity
3838
*
39+
* @example
3940
* v = y0( 1.0 );
4041
* // returns ~0.088
4142
*
43+
* @example
4244
* v = y0( -1.0 );
4345
* // returns NaN
4446
*
47+
* @example
4548
* v = y0( Infinity );
4649
* // returns 0.0
4750
*
51+
* @example
4852
* v = y0( -Infinity );
4953
* // returns NaN
5054
*
55+
* @example
5156
* v = y0( NaN );
5257
* // returns NaN
5358
*/

0 commit comments

Comments
 (0)