Skip to content

Commit 79044c6

Browse files
committed
docs: generate docs
1 parent a5ae34f commit 79044c6

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2541,6 +2541,17 @@ function quux () {
25412541
return foo;
25422542
}
25432543
// Message: Found more than one @returns declaration.
2544+
2545+
const language = {
2546+
/**
2547+
* @param {string} name
2548+
* @returns {string}
2549+
*/
2550+
get name() {
2551+
this._name = name;
2552+
}
2553+
}
2554+
// Message: JSDoc @returns declaration present but return expression not available in function.
25442555
````
25452556

25462557
The following patterns are not considered problems:
@@ -2720,6 +2731,16 @@ function quux () {
27202731
}
27212732
// Settings: {"jsdoc":{"forceRequireReturn":true}}
27222733
// Message: Missing JSDoc @returns declaration.
2734+
2735+
const language = {
2736+
/**
2737+
* @param {string} name
2738+
*/
2739+
get name() {
2740+
return this._name;
2741+
}
2742+
}
2743+
// Message: Missing JSDoc @returns declaration.
27232744
````
27242745

27252746
The following patterns are not considered problems:
@@ -2875,6 +2896,15 @@ class Foo {
28752896
}
28762897
}
28772898
// Settings: {"jsdoc":{"forceRequireReturn":true}}
2899+
2900+
const language = {
2901+
/**
2902+
* @param {string} name
2903+
*/
2904+
set name(name) {
2905+
this._name = name;
2906+
}
2907+
}
28782908
````
28792909

28802910

0 commit comments

Comments
 (0)