eslint-plugin-jsdoc 46.4.6 → 46.5.0

package/docs/rules/match-name.md

@@ -1,249 +0,0 @@
-<a name="user-content-match-name"></a>
-<a name="match-name"></a>
-### <code>match-name</code>
-
-
-
-Reports the name portion of a JSDoc tag if matching or not matching
-a given regular expression.
-
-Note that some tags do not possess names and anything appearing to be a
-name will actually be part of the description (e.g., for
-`@returns {type} notAName`). If you are defining your own tags, see the
-`structuredTags` setting (if `name: false`, this rule will not apply to
-that tag).
-
-<a name="user-content-fixer"></a>
-<a name="fixer"></a>
-## Fixer
-
-Will replace `disallowName` with `replacement` if these are provided.
-
-<a name="user-content-options"></a>
-<a name="options"></a>
-## Options
-
-A single options object with the following properties:
-
-<a name="user-content-options-match"></a>
-<a name="options-match"></a>
-### <code>match</code>
-
-`match` is a required option containing an array of objects which determine
-the conditions whereby a name is reported as being problematic.
-
-These objects can have any combination of the following groups of optional
-properties, all of which act to confine one another:
-
-- `tags` - This array should include tag names or `*` to indicate the
-  match will apply for all tags (except as confined by any context
-  properties). If `*` is not used, then these rules will only apply to
-  the specified tags. If `tags` is omitted, then `*` is assumed.
-
-- `allowName` - Indicates which names are allowed for the given tag (or `*`).
-    Accepts a string regular expression (optionally wrapped between two
-    `/` delimiters followed by optional flags) used to match the name.
-- `disallowName` - As with `allowName` but indicates names that are not
-    allowed.
-- `replacement` - If `disallowName` is supplied and this value is present, it
-    will replace the matched `disallowName` text.
-
-- `context` - AST to confine the allowing or disallowing to jsdoc blocks
-    associated with a particular context. See the
-    ["AST and Selectors"](#user-content-eslint-plugin-jsdoc-advanced-ast-and-selectors)
-    section of our README for more on the expected format.
-- `comment` - As with `context` but AST for the JSDoc block comment and types
-
-- `message` - An optional custom message to use when there is a match.
-
-Note that `comment`, even if targeting a specific tag, is used to match the
-whole block. So if a `comment` finds its specific tag, it may still apply
-fixes found by the likes of `disallowName` even when a different tag has the
-disallowed name. An alternative is to ensure that `comment` finds the specific
-tag of the desired tag and/or name and no `disallowName` (or `allowName`) is
-supplied. In such a case, only one error will be reported, but no fixer will
-be applied, however.
-
-<a name="user-content-context-and-settings"></a>
-<a name="context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|everywhere|
-|Tags|(The tags specified by `tags`, including any tag if `*` is set)|
-|Recommended|false|
-|Settings|`structuredTags`|
-|Options|`match`|
-
-<a name="user-content-failing-examples"></a>
-<a name="failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/**
- * @param opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i"}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @param opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","replacement":""}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @param a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^[a-z]+$/i"}]}]
-// Message: Only allowing names matching `/^[a-z]+$/i` but found "opt_b".
-
-/**
- * @param arg
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^[a-z]+$/i","disallowName":"/^arg/i"}]}]
-// Message: Only allowing names not matching `/^arg/i` but found "arg".
-
-/**
- * @param opt_a
- * @param arg
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^arg$/i"},{"disallowName":"/^opt_/i"}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @property opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","tags":["param"]}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_b".
-
-/**
- * @someTag opt_a
- * @param opt_b
- */
-// Settings: {"jsdoc":{"structuredTags":{"someTag":{"name":"namepath-defining"}}}}
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","tags":["param"]}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_b".
-
-/**
- * @property opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","tags":["*"]}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @param opt_a
- * @param opt_b
- */
-function quux () {
-}
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"context":"FunctionDeclaration","disallowName":"/^opt_/i"}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @property opt_a
- * @param {Bar|Foo} opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"][name=/opt_/] > JsdocTypeUnion:has(JsdocTypeName[value=\"Bar\"]:nth-child(1)))"}]}]
-// Message: Prohibited context for "opt_a".
-
-/**
- * @property opt_a
- * @param {Bar|Foo} opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"][name=/opt_/] > JsdocTypeUnion:has(JsdocTypeName[value=\"Bar\"]:nth-child(1)))","message":"Don't use `opt_` prefixes with Bar|..."}]}]
-// Message: Don't use `opt_` prefixes with Bar|...
-
-/**
- * @param opt_a
- * @param opt_b
- */
-function quux () {}
-// "jsdoc/match-name": ["error"|"warn", ]
-// Message: Rule `no-restricted-syntax` is missing a `match` option.
-
-/**
- * @param {
- *   someType
- * } opt_a
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","replacement":""}]}]
-// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
-
-/**
- * @template
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^$/","tags":["template"]}]}]
-// Message: Only allowing names not matching `/^$/u` but found "".
-````
-
-
-
-<a name="user-content-passing-examples"></a>
-<a name="passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/**
- * @param opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^arg/i"}]}]
-
-/**
- * @param a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^[a-z_]+$/i"}]}]
-
-/**
- * @param someArg
- * @param anotherArg
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"allowName":"/^[a-z]+$/i","disallowName":"/^arg/i"}]}]
-
-/**
- * @param elem1
- * @param elem2
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^arg$/i"},{"disallowName":"/^opt_/i"}]}]
-
-/**
- * @someTag opt_a
- * @param opt_b
- */
-// Settings: {"jsdoc":{"structuredTags":{"someTag":{"name":"namepath-defining"}}}}
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","tags":["property"]}]}]
-
-/**
- * @property opt_a
- * @param opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^arg/i","tags":["*"]}]}]
-
-/**
- * @param opt_a
- * @param opt_b
- */
-class A {
-}
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"context":"FunctionDeclaration","disallowName":"/^opt_/i"}]}]
-
-/**
- * @property opt_a
- * @param {Foo|Bar} opt_b
- */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"]:has(JsdocTypeUnion:has(JsdocTypeName[value=\"Bar\"]:nth-child(1))))","disallowName":"/^opt_/i"}]}]
-````
-

package/docs/rules/multiline-blocks.md

@@ -1,398 +0,0 @@
-<a name="user-content-multiline-blocks"></a>
-<a name="multiline-blocks"></a>
-### <code>multiline-blocks</code>
-
-
-
-Controls how and whether jsdoc blocks can be expressed as single or multiple
-line blocks.
-
-Note that if you set `noSingleLineBlocks` and `noMultilineBlocks` to `true`
-and configure them in a certain manner, you might effectively be prohibiting
-all jsdoc blocks!
-
-Also allows for preventing text at the very beginning or very end of blocks.
-
-<a name="user-content-fixer"></a>
-<a name="fixer"></a>
-## Fixer
-
-(TODO)
-
-<a name="user-content-options"></a>
-<a name="options"></a>
-## Options
-
-A single options object with the following properties.
-
-<a name="user-content-options-nozerolinetext-defaults-to-true"></a>
-<a name="options-nozerolinetext-defaults-to-true"></a>
-### <code>noZeroLineText</code> (defaults to <code>true</code>)
-
-For multiline blocks, any non-whitespace text immediately after the `/**` and
-space will be reported. (Text after a newline is not reported.)
-
-`noMultilineBlocks` will have priority over this rule if it applies.
-
-<a name="user-content-options-nofinallinetext-defaults-to-true"></a>
-<a name="options-nofinallinetext-defaults-to-true"></a>
-### <code>noFinalLineText</code> (defaults to <code>true</code>)
-
-For multiline blocks, any non-whitespace text preceding the `*/` on the final
-line will be reported. (Text preceding a newline is not reported.)
-
-`noMultilineBlocks` will have priority over this rule if it applies.
-
-<a name="user-content-options-nosinglelineblocks-defaults-to-false"></a>
-<a name="options-nosinglelineblocks-defaults-to-false"></a>
-### <code>noSingleLineBlocks</code> (defaults to <code>false</code>)
-
-If this is `true`, any single line blocks will be reported, except those which
-are whitelisted in `singleLineTags`.
-
-<a name="user-content-options-singlelinetags-defaults-to-lends-type"></a>
-<a name="options-singlelinetags-defaults-to-lends-type"></a>
-### <code>singleLineTags</code> (defaults to <code>[&#39;lends&#39;, &#39;type&#39;]</code>)
-
-An array of tags which can nevertheless be allowed as single line blocks when
-`noSingleLineBlocks` is set.  You may set this to a empty array to
-cause all single line blocks to be reported. If `'*'` is present, then
-the presence of a tag will allow single line blocks (but not if a tag is
-missing).
-
-<a name="user-content-options-nomultilineblocks-defaults-to-false"></a>
-<a name="options-nomultilineblocks-defaults-to-false"></a>
-### <code>noMultilineBlocks</code> (defaults to <code>false</code>)
-
-Requires that jsdoc blocks are restricted to single lines only unless impacted
-by the options `minimumLengthForMultiline`, `multilineTags`, or
-`allowMultipleTags`.
-
-<a name="user-content-options-minimumlengthformultiline-defaults-to-not-being-in-effect"></a>
-<a name="options-minimumlengthformultiline-defaults-to-not-being-in-effect"></a>
-### <code>minimumLengthForMultiline</code> (defaults to not being in effect)
-
-If `noMultilineBlocks` is set with this numeric option, multiline blocks will
-be permitted if containing at least the given amount of text.
-
-If not set, multiline blocks will not be permitted regardless of length unless
-a relevant tag is present and `multilineTags` is set.
-
-<a name="user-content-options-multilinetags-defaults-to"></a>
-<a name="options-multilinetags-defaults-to"></a>
-### <code>multilineTags</code> (defaults to <code>[&#39;*&#39;]</code>)
-
-If `noMultilineBlocks` is set with this option, multiline blocks may be allowed
-regardless of length as long as a tag or a tag of a certain type is present.
-
-If `*` is included in the array, the presence of a tags will allow for
-multiline blocks (but not when without any tags unless the amount of text is
-over an amount specified by `minimumLengthForMultiline`).
-
-If the array does not include `*` but lists certain tags, the presence of
-such a tag will cause multiline blocks to be allowed.
-
-You may set this to an empty array to prevent any tag from permitting multiple
-lines.
-
-<a name="user-content-options-allowmultipletags-defaults-to-true"></a>
-<a name="options-allowmultipletags-defaults-to-true"></a>
-### <code>allowMultipleTags</code> (defaults to <code>true</code>)
-
-If `noMultilineBlocks` is set to `true` with this option and multiple tags are
-found in a block, an error will not be reported.
-
-Since multiple-tagged lines cannot be collapsed into a single line, this option
-prevents them from being reported. Set to `false` if you really want to report
-any blocks.
-
-This option will also be applied when there is a block description and a single
-tag (since a description cannot precede a tag on a single line, and also
-cannot be reliably added after the tag either).
-
-<a name="user-content-context-and-settings"></a>
-<a name="context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|everywhere|
-|Tags|Any (though `singleLineTags` and `multilineTags` control the application)|
-|Recommended|true|
-|Settings||
-|Options|`allowMultipleTags`, `minimumLengthForMultiline`, `multilineTags`, `noFinalLineText`, `noMultilineBlocks`, `noSingleLineBlocks`, `noZeroLineText`, `singleLineTags`|
-
-<a name="user-content-failing-examples"></a>
-<a name="failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/** Reported up here
- * because the rest is multiline
- */
-// Message: Should have no text on the "0th" line (after the `/**`).
-
-/** Reported up here
- * because the rest is multiline
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noZeroLineText":true}]
-// Message: Should have no text on the "0th" line (after the `/**`).
-
-/** @abc {aType} aName Reported up here
- * because the rest is multiline
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noZeroLineText":true}]
-// Message: Should have no text on the "0th" line (after the `/**`).
-
-/** @tag */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true}]
-// Message: Single line blocks are not permitted by your configuration.
-
-/** @tag {someType} */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true}]
-// Message: Single line blocks are not permitted by your configuration.
-
-/** @tag {someType} aName */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true}]
-// Message: Single line blocks are not permitted by your configuration.
-
-/** @tag */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true,"singleLineTags":["someOtherTag"]}]
-// Message: Single line blocks are not permitted by your configuration.
-
-/** desc */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true,"singleLineTags":["*"]}]
-// Message: Single line blocks are not permitted by your configuration.
-
-/**
- * Desc.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/** desc
- *
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/** desc
- *
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true,"noSingleLineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but fixing would result in a single line block which you have prohibited with `noSingleLineBlocks`.
-
-/**
- *
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * This is not long enough to be permitted.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":100,"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * This is not long enough to be permitted.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":true,"minimumLengthForMultiline":100,"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * This has the wrong tags so is not permitted.
- * @notTheRightTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":false,"multilineTags":["onlyThisIsExempted"],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but the block has a description with a tag.
-
-/**
- * This has too many tags so cannot be fixed ot a single line.
- * @oneTag
- * @anotherTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":false,"multilineTags":[],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but the block has multiple tags.
-
-/**
- * This has a tag and description so cannot be fixed ot a single line.
- * @oneTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":false,"multilineTags":[],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but the block has a description with a tag.
-
-/**
- * This has no tags so is not permitted.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":["*"],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * This has the wrong tags so is not permitted.
- * @notTheRightTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":false,"minimumLengthForMultiline":500,"multilineTags":["onlyThisIsExempted"],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but the block has a description with a tag.
-
-/**
- * @lends This can be safely fixed to a single line.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":[],"noMultilineBlocks":true,"noSingleLineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * @type {aType} This can be safely fixed to a single line.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":[],"noMultilineBlocks":true,"noSingleLineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * @aTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":[],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * This is a problem when single and multiline are blocked.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true,"noSingleLineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration but fixing would result in a single line block which you have prohibited with `noSingleLineBlocks`.
-
-/** This comment is bad
- * It should not have text on line zero
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":50,"noMultilineBlocks":true,"noZeroLineText":true}]
-// Message: Should have no text on the "0th" line (after the `/**`).
-
-/**
- * @lends This can be safely fixed
- * to a single
- * line. */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":[],"noMultilineBlocks":true}]
-// Message: Multiline jsdoc blocks are prohibited by your configuration.
-
-/**
- * @someTag {aType} with Description */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noFinalLineText":true}]
-// Message: Should have no text on the final line (before the `*/`).
-
-/**
- * Description */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noFinalLineText":true}]
-// Message: Should have no text on the final line (before the `*/`).
-````
-
-
-
-<a name="user-content-passing-examples"></a>
-<a name="passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/** Not reported */
-
-/**
- *  Not reported
- */
-
-/** Reported up here
- * because the rest is multiline
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noZeroLineText":false}]
-
-/** @tag */
-
-/** @lends */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true}]
-
-/** @tag */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true,"singleLineTags":["tag"]}]
-
-/** @tag */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noSingleLineBlocks":true,"singleLineTags":["*"]}]
-
-/**
- *
- */
-
-/**
- *
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":false}]
-
-/** Test */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true}]
-
-/**
- * This is long enough to be permitted by our config.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":25,"noMultilineBlocks":true}]
-
-/**
- * This is long enough to be permitted by our config.
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":50,"noMultilineBlocks":true}]
-
-/**
- * This has the right tag so is permitted.
- * @theRightTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":["theRightTag"],"noMultilineBlocks":true}]
-
-/** This has no tags but is single line so is not permitted. */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":["*"],"noMultilineBlocks":true}]
-
-/**
- * This has the wrong tags so is not permitted.
- * @notTheRightTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":10,"multilineTags":["onlyThisIsExempted"],"noMultilineBlocks":true}]
-
-/**
- * This has the wrong tags so is not permitted.
- * @theRightTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"minimumLengthForMultiline":500,"multilineTags":["theRightTag"],"noMultilineBlocks":true}]
-
-/** tag */
-
-/**
- * @lends This is ok per multiline
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noMultilineBlocks":true,"noSingleLineBlocks":true}]
-
-/**
- * This has too many tags so cannot be fixed ot a single line.
- * @oneTag
- * @anotherTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"multilineTags":[],"noMultilineBlocks":true}]
-
-/**
- * This has too many tags so cannot be fixed ot a single line.
- * @oneTag
- * @anotherTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":true,"multilineTags":[],"noMultilineBlocks":true}]
-
-/**
- * This has a tag and description so cannot be fixed ot a single line.
- * @oneTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":true,"multilineTags":[],"noMultilineBlocks":true}]
-
-/**
- * This has a tag and description so cannot be fixed ot a single line.
- * @oneTag
- */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"allowMultipleTags":false,"multilineTags":["oneTag"],"noMultilineBlocks":true}]
-
-/** @someTag with Description */
-// "jsdoc/multiline-blocks": ["error"|"warn", {"noFinalLineText":true}]
-````
-