Skip to content

Commit f81eb1c

Browse files
committed
docs: generate docs
1 parent 8512e40 commit f81eb1c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -388,15 +388,15 @@ function quux (foo) {
388388
}
389389
// Message: Expected JSDoc block to be aligned.
390390

391-
/**
391+
/**
392392
* @param {Number} foo
393393
*/
394394
function quux (foo) {
395395

396396
}
397397
// Message: Expected JSDoc block to be aligned.
398398

399-
/**
399+
/**
400400
* @param {Number} foo
401401
*/
402402
function quux (foo) {
@@ -3410,7 +3410,7 @@ An option object may have the following key:
34103410
The following patterns are considered problems:
34113411

34123412
````js
3413-
/**
3413+
/**
34143414
* @param {HerType} baz - Foo.
34153415
*/
34163416
function quux(foo, bar, baz) {
@@ -3419,7 +3419,7 @@ function quux(foo, bar, baz) {
34193419
// Settings: {"jsdoc":{"preferredTypes":{"HerType":1000}}}
34203420
// Message: Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.
34213421

3422-
/**
3422+
/**
34233423
* @param {HerType} baz - Foo.
34243424
*/
34253425
function quux(foo, bar, baz) {
@@ -3446,7 +3446,7 @@ function quux(foo, bar) {
34463446
// Options: [{"definedTypes":["MyType"]}]
34473447
// Message: The type 'HisType' is undefined.
34483448

3449-
/**
3449+
/**
34503450
* @param {MyType} foo - Bar.
34513451
* @param {HisType} bar - Foo.
34523452
* @param {HerType} baz - Foo.
@@ -3458,7 +3458,7 @@ function quux(foo, bar, baz) {
34583458
// Options: [{"definedTypes":["MyType"]}]
34593459
// Message: The type 'HisType' is undefined.
34603460

3461-
/**
3461+
/**
34623462
* @param {MyType} foo - Bar.
34633463
* @param {HisType} bar - Foo.
34643464
* @param {HerType} baz - Foo.
@@ -3642,7 +3642,7 @@ function quux(foo, bar) {
36423642
}
36433643
// Options: [{"definedTypes":["MyType","HisType"]}]
36443644

3645-
/**
3645+
/**
36463646
* @param {MyType} foo - Bar.
36473647
* @param {HisType} bar - Foo.
36483648
* @param {HerType} baz - Foo.
@@ -3653,7 +3653,7 @@ function quux(foo, bar, baz) {
36533653
// Settings: {"jsdoc":{"preferredTypes":{"hertype":{"replacement":"HerType"},"histype":"HisType"}}}
36543654
// Options: [{"definedTypes":["MyType"]}]
36553655

3656-
/**
3656+
/**
36573657
* @param {MyType} foo - Bar.
36583658
* @param {HisType} bar - Foo.
36593659
* @param {HerType} baz - Foo.

0 commit comments

Comments
 (0)