Skip to content

Commit c18e6d3

Browse files
committed
docs: generate docs
1 parent e273fba commit c18e6d3

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,6 +1396,15 @@ String | **string** | **string** | `("test") instanceof String` -> **`false`**
13961396
The following patterns are considered problems:
13971397

13981398
````js
1399+
/**
1400+
* @param {abc} foo
1401+
*/
1402+
function quux (foo) {
1403+
1404+
}
1405+
// Settings: {"jsdoc":{"preferredTypes":{"abc":100}}}
1406+
// Message: Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.
1407+
13991408
/**
14001409
* @param {Number} foo
14011410
*/
@@ -2694,6 +2703,26 @@ An option object may have the following keys:
26942703
The following patterns are considered problems:
26952704

26962705
````js
2706+
/**
2707+
* @param {HerType} baz - Foo.
2708+
*/
2709+
function quux(foo, bar, baz) {
2710+
2711+
}
2712+
// Settings: {"jsdoc":{"preferredTypes":{"HerType":1000}}}
2713+
// Options: [{"preferredTypesDefined":true}]
2714+
// Message: Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.
2715+
2716+
/**
2717+
* @param {HerType} baz - Foo.
2718+
*/
2719+
function quux(foo, bar, baz) {
2720+
2721+
}
2722+
// Settings: {"jsdoc":{"preferredTypes":{"HerType":false}}}
2723+
// Options: [{"preferredTypesDefined":true}]
2724+
// Message: The type 'HerType' is undefined.
2725+
26972726
/**
26982727
* @param {strnig} foo - Bar.
26992728
*/
@@ -2846,6 +2875,15 @@ function foo () {
28462875

28472876
}
28482877

2878+
/**
2879+
*
2880+
*
2881+
*/
2882+
function foo () {
2883+
2884+
}
2885+
// Options: [{"preferredTypesDefined":true}]
2886+
28492887
/**
28502888
* @param {MyType} foo - Bar.
28512889
* @param {HisType} bar - Foo.
@@ -4830,6 +4868,18 @@ function quux () {
48304868

48314869
}
48324870
// Options: [{"exemptedBy":["type"]}]
4871+
4872+
/**
4873+
* @override
4874+
*/
4875+
var A = class {
4876+
/**
4877+
*
4878+
*/
4879+
quux (foo) {
4880+
4881+
}
4882+
}
48334883
````
48344884

48354885

0 commit comments

Comments
 (0)