Skip to content

Commit

Permalink
docs: generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yeonjuan committed Jul 15, 2019
1 parent 8512e40 commit f81eb1c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Expand Up @@ -388,15 +388,15 @@ function quux (foo) {
}
// Message: Expected JSDoc block to be aligned.

/**
/**
* @param {Number} foo
*/
function quux (foo) {

}
// Message: Expected JSDoc block to be aligned.

/**
/**
* @param {Number} foo
*/
function quux (foo) {
Expand Down Expand Up @@ -3410,7 +3410,7 @@ An option object may have the following key:
The following patterns are considered problems:

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

/**
/**
* @param {HerType} baz - Foo.
*/
function quux(foo, bar, baz) {
Expand All @@ -3446,7 +3446,7 @@ function quux(foo, bar) {
// Options: [{"definedTypes":["MyType"]}]
// Message: The type 'HisType' is undefined.

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

/**
/**
* @param {MyType} foo - Bar.
* @param {HisType} bar - Foo.
* @param {HerType} baz - Foo.
Expand Down Expand Up @@ -3642,7 +3642,7 @@ function quux(foo, bar) {
}
// Options: [{"definedTypes":["MyType","HisType"]}]

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

/**
/**
* @param {MyType} foo - Bar.
* @param {HisType} bar - Foo.
* @param {HerType} baz - Foo.
Expand Down

0 comments on commit f81eb1c

Please sign in to comment.