Skip to content

Commit 57f33da

Browse files
committed
docs: generate docs
1 parent 3c39014 commit 57f33da

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -742,6 +742,14 @@ function f () {
742742
}
743743
// Settings: {"jsdoc":{"allowInlineConfig":true,"baseConfig":{},"captionRequired":false,"configFile":"configFile.js","eslintrcForExamples":true,"exampleCodeRegex":".*?","matchingFileName":"test.md","noDefaultExampleRules":false,"rejectExampleCodeRegex":"\\W*","reportUnusedDisableDirectives":true}}
744744
// Message: `settings.jsdoc.captionRequired` has been removed, use options in the rule `check-examples` instead.
745+
746+
/**
747+
* @typedef {string} Foo
748+
* @example <caption></caption>
749+
* 'foo'
750+
*/
751+
// Options: [{"captionRequired":true,"eslintrcForExamples":false}]
752+
// Message: Caption is expected for examples.
745753
````
746754

747755
The following patterns are not considered problems:

0 commit comments

Comments
 (0)