docs: generate docs

Author: gajus

README.md

@@ -310,178 +310,6 @@ command.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|`param`|
 
-The following patterns are considered problems:
-
-```js
-/**
- * @example alert('hello')
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"no-alert":2,"semi":["error","always"]}},"eslintrcForExamples":false}}
-// Message: @example error (no-alert): Unexpected alert.
-
-/**
- * @example ```js
- alert('hello');
- ```
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js([\\s\\S]*)```"}}
-// Message: undefined
-
-/**
- * @example
- * ```js alert('hello'); ```
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js ([\\s\\S]*)```"}}
-// Message: undefined
-
-/**
- * @example ```
- * js alert('hello'); ```
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```\njs ([\\s\\S]*)```"}}
-// Message: undefined
-
-/**
- * @example <b>Not JavaScript</b>
- */
-function quux () {
-
-}
-/**
- * @example quux2();
- */
-function quux2 () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","never"]}},"eslintrcForExamples":false,"rejectExampleCodeRegex":"^\\s*<.*>$"}}
-// Message: undefined
-
-/**
- * @example
- * quux(); // does something useful
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"no-undef":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-// Message: undefined
-
-/**
- * @example <caption>Valid usage</caption>
- * quux(); // does something useful
- *
- * @example
- * quux('random unwanted arg'); // results in an error
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"captionRequired":true,"eslintrcForExamples":false}}
-// Message: undefined
-
-/**
- * @example  quux();
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"indent":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":false}}
-// Message: undefined
-
-/**
- * @example test() // eslint-disable-line semi
- */
-function quux () {}
-// Settings: {"jsdoc":{"eslintrcForExamples":false,"noDefaultExampleRules":true,"reportUnusedDisableDirectives":true}}
-// Message: undefined
-
-/**
- * @example
- test() // eslint-disable-line semi
- */
-function quux () {}
-// Settings: {"jsdoc":{"allowInlineConfig":false,"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-// Message: undefined
-```
-
-The following patterns are not considered problems:
-
-```js
-/**
- * @example ```js
- alert('hello');
- ```
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"exampleCodeRegex":"```js([\\s\\S]*)```"}}
-
-/**
- * @example
- * // arbitrary example content
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"eslintrcForExamples":false}}
-
-/**
- * @example
- * quux(); // does something useful
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"no-undef":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":false}}
-
-/**
- * @example quux();
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"baseConfig":{"rules":{"indent":["error"]}},"eslintrcForExamples":false,"noDefaultExampleRules":false}}
-
-/**
- * @example <caption>Valid usage</caption>
- * quux(); // does something useful
- *
- * @example <caption>Invalid usage</caption>
- * quux('random unwanted arg'); // results in an error
- */
-function quux () {
-
-}
-// Settings: {"jsdoc":{"captionRequired":true,"eslintrcForExamples":false}}
-
-/**
- * @example test() // eslint-disable-line semi
- */
-function quux () {}
-// Settings: {"jsdoc":{"eslintrcForExamples":false,"noDefaultExampleRules":true,"reportUnusedDisableDirectives":false}}
-
-/**
- * @example
- test() // eslint-disable-line semi
- */
-function quux () {}
-// Settings: {"jsdoc":{"allowInlineConfig":true,"baseConfig":{"rules":{"semi":["error","always"]}},"eslintrcForExamples":false,"noDefaultExampleRules":true}}
-```
-
-
 <a name="eslint-plugin-jsdoc-rules-check-param-names"></a>
 ### <code>check-param-names</code>