Skip to content

Commit e343ab5

Browse files
brettz9brettz9
committed
chore: update jsdoccomment and devDeps.
Also: - chore: remove test dupes and fix output=null
1 parent ab5624b commit e343ab5

36 files changed

+1287
-1825
lines changed

‎docs/rules/check-line-alignment.md

-10
Original file line numberDiff line numberDiff line change
@@ -128,16 +128,6 @@ const fn = ( lorem, sit ) => {}
128128
// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
129129
// Message: Expected JSDoc block lines to be aligned.
130130

131-
/**
132-
* Function description.
133-
*
134-
* @param {string} lorem Description.
135-
* @param {int} sit Description multi words.
136-
*/
137-
const fn = ( lorem, sit ) => {}
138-
// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
139-
// Message: Expected JSDoc block lines to be aligned.
140-
141131
/**
142132
* Function description.
143133
*

‎docs/rules/check-param-names.md

+3-11
Original file line numberDiff line numberDiff line change
@@ -864,17 +864,9 @@ function quux (foo, bar, ...extra) {
864864
}
865865

866866
/**
867-
* Converts an SVGRect into an object.
868-
* @param {SVGRect} bbox - a SVGRect
869-
*/
870-
const bboxToObj = function ({x, y, width, height}) {
871-
return {x, y, width, height};
872-
};
873-
874-
/**
875-
* Converts an SVGRect into an object.
876-
* @param {SVGRect} bbox - a SVGRect
877-
*/
867+
* Converts an SVGRect into an object.
868+
* @param {SVGRect} bbox - a SVGRect
869+
*/
878870
const bboxToObj = function ({x, y, width, height}) {
879871
return {x, y, width, height};
880872
};

‎docs/rules/check-tag-names.md

-9
Original file line numberDiff line numberDiff line change
@@ -517,15 +517,6 @@ function quux () {
517517
*/
518518
function quux () {
519519

520-
}
521-
// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use x-todo instead of todo","replacement":"x-todo"}}}}
522-
// Message: Please use x-todo instead of todo
523-
524-
/**
525-
* @todo
526-
*/
527-
function quux () {
528-
529520
}
530521
// Settings: {"jsdoc":{"tagNamePreference":{"todo":55}}}
531522
// Message: Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.

‎docs/rules/check-types.md

-9
Original file line numberDiff line numberDiff line change
@@ -352,15 +352,6 @@ function qux(baz) {
352352
// Settings: {"jsdoc":{"preferredTypes":{"*":"aaa","abc":"Abc","string":"Str"}}}
353353
// Message: Invalid JSDoc @param "baz" type "*"; prefer: "aaa".
354354

355-
/**
356-
* @param {abc} foo
357-
* @param {Number} bar
358-
*/
359-
function qux(foo, bar) {
360-
}
361-
// Settings: {"jsdoc":{"preferredTypes":{"abc":"Abc","string":"Str"}}}
362-
// Message: Invalid JSDoc @param "foo" type "abc"; prefer: "Abc".
363-
364355
/**
365356
* @param {Array} foo
366357
*/

‎docs/rules/match-description.md

-6
Original file line numberDiff line numberDiff line change
@@ -241,12 +241,6 @@ const q = class {
241241
// "jsdoc/match-description": ["error"|"warn", {"contexts":["any"]}]
242242
// Message: JSDoc description does not satisfy the regex pattern.
243243

244-
/**
245-
* foo.
246-
*/
247-
// "jsdoc/match-description": ["error"|"warn", {"contexts":["any"]}]
248-
// Message: JSDoc description does not satisfy the regex pattern.
249-
250244
/**
251245
* foo.
252246
*/

‎docs/rules/no-undefined-types.md

-9
Original file line numberDiff line numberDiff line change
@@ -361,15 +361,6 @@ const MyType = require('my-library').MyType;
361361

362362
}
363363

364-
const MyType = require('my-library').MyType;
365-
366-
/**
367-
* @param {MyType} foo - Bar.
368-
*/
369-
function quux(foo) {
370-
371-
}
372-
373364
import {MyType} from 'my-library';
374365

375366
/**

‎docs/rules/require-description.md

-18
Original file line numberDiff line numberDiff line change
@@ -133,24 +133,6 @@ class quux {
133133
// "jsdoc/require-description": ["error"|"warn", {"contexts":["any"],"descriptionStyle":"tag"}]
134134
// Message: Missing JSDoc @description declaration.
135135

136-
/**
137-
*
138-
*/
139-
class quux {
140-
141-
}
142-
// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
143-
// Message: Missing JSDoc @description declaration.
144-
145-
/**
146-
*
147-
*/
148-
class quux {
149-
150-
}
151-
// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
152-
// Message: Missing JSDoc @description declaration.
153-
154136
/**
155137
* @description
156138
*/

‎docs/rules/require-jsdoc.md

-11
Original file line numberDiff line numberDiff line change
@@ -600,12 +600,6 @@ export function someMethod() {
600600
// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
601601
// Message: Missing JSDoc comment.
602602

603-
export function someMethod() {
604-
605-
}
606-
// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
607-
// Message: Missing JSDoc comment.
608-
609603
const myObject = {
610604
myProp: true
611605
};
@@ -1566,11 +1560,6 @@ export function someMethod() {
15661560
}
15671561
// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
15681562

1569-
export function someMethod() {
1570-
1571-
}
1572-
// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
1573-
15741563
exports.someMethod = function() {
15751564

15761565
}

‎docs/rules/require-param.md

-50
Original file line numberDiff line numberDiff line change
@@ -627,14 +627,6 @@ function quux (foo) {
627627
// Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
628628
// Message: Missing JSDoc @arg "foo" declaration.
629629

630-
/**
631-
* @param foo
632-
*/
633-
function quux (foo, bar) {
634-
635-
}
636-
// Message: Missing JSDoc @param "bar" declaration.
637-
638630
/**
639631
* @override
640632
*/
@@ -1351,22 +1343,6 @@ function quux (foo) {
13511343

13521344
}
13531345

1354-
/**
1355-
* @augments
1356-
*/
1357-
function quux (foo) {
1358-
1359-
}
1360-
// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
1361-
1362-
/**
1363-
* @extends
1364-
*/
1365-
function quux (foo) {
1366-
1367-
}
1368-
// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
1369-
13701346
/**
13711347
* @override
13721348
*/
@@ -1480,32 +1456,6 @@ class A {
14801456
}
14811457
}
14821458

1483-
/**
1484-
* @augments
1485-
*/
1486-
class A {
1487-
/**
1488-
*
1489-
*/
1490-
quux (foo) {
1491-
1492-
}
1493-
}
1494-
// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
1495-
1496-
/**
1497-
* @extends
1498-
*/
1499-
class A {
1500-
/**
1501-
*
1502-
*/
1503-
quux (foo) {
1504-
1505-
}
1506-
}
1507-
// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
1508-
15091459
/**
15101460
* @internal
15111461
*/

‎docs/rules/require-returns-check.md

-57
Original file line numberDiff line numberDiff line change
@@ -368,20 +368,6 @@ function foo() {
368368
};
369369
// Message: JSDoc @returns declaration present but return expression not available in function.
370370

371-
/**
372-
* @returns {SomeType} Baz.
373-
*/
374-
function foo() {
375-
switch (true) {
376-
default:
377-
switch (false) {
378-
default: return;
379-
}
380-
return "baz";
381-
}
382-
};
383-
// Message: JSDoc @returns declaration present but return expression not available in function.
384-
385371
/**
386372
* @returns {number}
387373
*/
@@ -422,14 +408,6 @@ function quux () {
422408
return foo;
423409
}
424410

425-
/**
426-
* @returns {string} Foo.
427-
*/
428-
function quux () {
429-
430-
return foo;
431-
}
432-
433411
/**
434412
*
435413
*/
@@ -580,17 +558,6 @@ function quux () {
580558
return true;
581559
}
582560

583-
/**
584-
* @returns {true}
585-
*/
586-
function quux () {
587-
try {
588-
return true;
589-
} catch (err) {
590-
}
591-
return true;
592-
}
593-
594561
/**
595562
* @returns {true}
596563
*/
@@ -614,17 +581,6 @@ function quux () {
614581
return true;
615582
}
616583

617-
/**
618-
* @returns {true}
619-
*/
620-
function quux () {
621-
switch (true) {
622-
case 'abc':
623-
return true;
624-
}
625-
return true;
626-
}
627-
628584
/**
629585
* @returns {true}
630586
*/
@@ -1016,19 +972,6 @@ function foo() {
1016972
}
1017973
};
1018974

1019-
/**
1020-
* @returns Baz.
1021-
*/
1022-
function foo() {
1023-
switch (true) {
1024-
default:
1025-
switch (false) {
1026-
default: return;
1027-
}
1028-
return "baz";
1029-
}
1030-
};
1031-
1032975
/**
1033976
* @returns
1034977
*/

‎docs/rules/require-returns.md

-13
Original file line numberDiff line numberDiff line change
@@ -864,12 +864,6 @@ const quux = () => {
864864

865865
}
866866

867-
/**
868-
*
869-
*/
870-
function quux () {
871-
}
872-
873867
/**
874868
*
875869
*/
@@ -924,13 +918,6 @@ function quux () {
924918
return;
925919
}
926920

927-
/**
928-
* @returns {void}
929-
*/
930-
function quux () {
931-
}
932-
// "jsdoc/require-returns": ["error"|"warn", {"forceRequireReturn":true}]
933-
934921
/**
935922
* @returns {void}
936923
*/

‎docs/rules/require-yields-check.md

-8
Original file line numberDiff line numberDiff line change
@@ -238,14 +238,6 @@ function * quux () {
238238
yield foo;
239239
}
240240

241-
/**
242-
* @yields {string} Foo.
243-
*/
244-
function * quux () {
245-
246-
yield foo;
247-
}
248-
249241
/**
250242
*
251243
*/

‎docs/rules/require-yields.md

-23
Original file line numberDiff line numberDiff line change
@@ -443,17 +443,6 @@ function * quux () {
443443
}
444444
// Message: Missing JSDoc @yields declaration.
445445

446-
/**
447-
*
448-
*/
449-
function * quux () {
450-
if (true) {
451-
yield;
452-
}
453-
yield true;
454-
}
455-
// Message: Missing JSDoc @yields declaration.
456-
457446
/**
458447
*
459448
*/
@@ -586,12 +575,6 @@ function * quux (foo) {
586575
yield foo;
587576
}
588577

589-
/**
590-
* @constructor
591-
*/
592-
function * quux (foo) {
593-
}
594-
595578
/**
596579
* @yields {object}
597580
*/
@@ -612,12 +595,6 @@ function * quux () {
612595
function * quux () {
613596
}
614597

615-
/**
616-
*
617-
*/
618-
function * quux () {
619-
}
620-
621598
/**
622599
* @yields {void}
623600
*/

0 commit comments

Comments
 (0)