Skip to content

Commit 8b23024

Browse files
committed
docs: generate docs
1 parent fd78a9e commit 8b23024

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1823,6 +1823,23 @@ function quux () {
18231823
*/
18241824
function quux () {
18251825

1826+
}
1827+
// Message: Missing JSDoc @example description.
1828+
1829+
/**
1830+
* @constructor
1831+
*/
1832+
function quux () {
1833+
1834+
}
1835+
// Message: Missing JSDoc @example declaration.
1836+
1837+
/**
1838+
* @constructor
1839+
* @example
1840+
*/
1841+
function quux () {
1842+
18261843
}
18271844
// Message: Missing JSDoc @example description.
18281845
````
@@ -1855,6 +1872,30 @@ function quux () {
18551872
*/
18561873
function quux () {
18571874

1875+
}
1876+
1877+
/**
1878+
* @constructor
1879+
*/
1880+
function quux () {
1881+
1882+
}
1883+
// Settings: {"jsdoc":{"avoidExampleOnConstructors":true}}
1884+
1885+
/**
1886+
* @constructor
1887+
* @example
1888+
*/
1889+
function quux () {
1890+
1891+
}
1892+
// Settings: {"jsdoc":{"avoidExampleOnConstructors":true}}
1893+
1894+
/**
1895+
* @inheritdoc
1896+
*/
1897+
function quux () {
1898+
18581899
}
18591900
````
18601901

0 commit comments

Comments
 (0)