docs: update generated docs

brettz9 · Aug 5, 2024 · b3c6c02 · b3c6c02
1 parent 0973caf
commit b3c6c02
Show file tree

Hide file tree

Showing 56 changed files with 112 additions and 112 deletions.
diff --git a/docs/rules/check-access.md b/docs/rules/check-access.md
@@ -36,7 +36,7 @@ Also reports:
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @access foo
  */
@@ -145,7 +145,7 @@ function quux (foo) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  *
  */

diff --git a/docs/rules/check-alignment.md b/docs/rules/check-alignment.md
@@ -32,7 +32,7 @@ Fixes alignment.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
   * @param {Number} foo
  */
@@ -120,7 +120,7 @@ class Foo {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * Desc
  *

diff --git a/docs/rules/check-examples.md b/docs/rules/check-examples.md
@@ -220,7 +220,7 @@ expression-oriented rules will be used by default as well:
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @example alert('hello')
  */
@@ -563,7 +563,7 @@ const functionName = function (paramOne, paramTwo,
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @example ```js
  alert('hello');

diff --git a/docs/rules/check-indentation.md b/docs/rules/check-indentation.md
@@ -72,7 +72,7 @@ report a padding issue:
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**  foo */
 function quux () {
 
@@ -188,7 +188,7 @@ function quux () {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * foo
  *

diff --git a/docs/rules/check-line-alignment.md b/docs/rules/check-line-alignment.md
@@ -97,7 +97,7 @@ Disables `wrapIndent`; existing wrap indentation is preserved without changes.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * Function description.
  *
@@ -582,7 +582,7 @@ function quux () {}
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * Function description.
  *

diff --git a/docs/rules/check-param-names.md b/docs/rules/check-param-names.md
@@ -141,7 +141,7 @@ Whether to avoid checks for missing `@param` definitions. Defaults to `false`. C
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @param Foo
  */
@@ -691,7 +691,7 @@ export function fn(...[type, arg]: FnArgs): void {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  *
  */

diff --git a/docs/rules/check-property-names.md b/docs/rules/check-property-names.md
@@ -52,7 +52,7 @@ be removed even if it has a different type or description).
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @typedef (SomeType) SomeTypedef
  * @property Foo.Bar
@@ -175,7 +175,7 @@ function quux ({foo, bar}, baz) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  *
  */

diff --git a/docs/rules/check-syntax.md b/docs/rules/check-syntax.md
@@ -36,7 +36,7 @@ rule is enforced (except under "permissive" and "closure" modes).
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @param {string=} foo
  */
@@ -54,7 +54,7 @@ function quux (foo) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @param {string=} foo
  */

diff --git a/docs/rules/check-tag-names.md b/docs/rules/check-tag-names.md
@@ -322,7 +322,7 @@ this
 
 The following patterns are considered problems:
 
-````js
+````ts
 /** @type {string} */let a;
 // "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
 // Message: '@type' is redundant when using a type system.
@@ -775,7 +775,7 @@ function quux () {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /** @default 0 */
 let a;
 // "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]

diff --git a/docs/rules/check-types.md b/docs/rules/check-types.md
@@ -192,7 +192,7 @@ permitted.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @param {abc} foo
  */
@@ -856,7 +856,7 @@ function a () {}
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @param {number} foo
  * @param {Bar} bar

diff --git a/docs/rules/check-values.md b/docs/rules/check-values.md
@@ -88,7 +88,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @version
  */
@@ -270,7 +270,7 @@ function quux (foo) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @version 3.4.1
  */

diff --git a/docs/rules/convert-to-jsdoc-comments.md b/docs/rules/convert-to-jsdoc-comments.md
@@ -100,7 +100,7 @@ Defaults to `VariableDeclarator`, `TSPropertySignature`, `PropertyDefinition`.
 
 The following patterns are considered problems:
 
-````js
+````ts
 // A single line comment
 function quux () {}
 // "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}]
@@ -211,7 +211,7 @@ var a = []; // Test comment
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /** A single line comment */
 function quux () {}
 // "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}]

diff --git a/docs/rules/empty-tags.md b/docs/rules/empty-tags.md
@@ -75,7 +75,7 @@ add them within this option.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @abstract extra text
  */
@@ -153,7 +153,7 @@ function quux () {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @abstract
  */

diff --git a/docs/rules/implements-on-classes.md b/docs/rules/implements-on-classes.md
@@ -55,7 +55,7 @@ section of our README for more on the expected format.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @implements {SomeClass}
  */
@@ -136,7 +136,7 @@ class Foo {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @implements {SomeClass}
  * @class

diff --git a/docs/rules/imports-as-dependencies.md b/docs/rules/imports-as-dependencies.md
@@ -19,7 +19,7 @@ which is not listed in `dependencies` or `devDependencies`.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @type {null|import('sth').SomeApi}
  */
@@ -50,7 +50,7 @@ The following patterns are considered problems:
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @type {null|import('eslint').ESLint}
  */

diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md
@@ -102,7 +102,7 @@ The default `uselessWords` option is:
 
 The following patterns are considered problems:
 
-````js
+````ts
 /** the  */
 let myValue = 3;
 // Message: This description only repeats the name it describes.
@@ -300,7 +300,7 @@ export default function packageNameFromPath(path) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**   */
 let myValue = 3;
 

diff --git a/docs/rules/match-description.md b/docs/rules/match-description.md
@@ -216,7 +216,7 @@ section of our README for more on the expected format.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * foo.
  */
@@ -633,7 +633,7 @@ function quux () {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  *
  */

diff --git a/docs/rules/match-name.md b/docs/rules/match-name.md
@@ -82,7 +82,7 @@ be applied, however.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  * @param opt_a
  * @param opt_b
@@ -194,7 +194,7 @@ function quux () {}
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @param opt_a
  * @param opt_b

diff --git a/docs/rules/multiline-blocks.md b/docs/rules/multiline-blocks.md
@@ -128,7 +128,7 @@ cannot be reliably added after the tag either).
 
 The following patterns are considered problems:
 
-````js
+````ts
 /** Reported up here
  * because the rest is multiline
  */
@@ -293,7 +293,7 @@ The following patterns are considered problems:
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /** Not reported */
 
 /**

diff --git a/docs/rules/no-bad-blocks.md b/docs/rules/no-bad-blocks.md
@@ -57,7 +57,7 @@ apparent tag content.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /*
  * @param foo
  */
@@ -117,7 +117,7 @@ function quux (foo) {
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * @property foo
  */

diff --git a/docs/rules/no-blank-block-descriptions.md b/docs/rules/no-blank-block-descriptions.md
@@ -34,7 +34,7 @@ in the block description.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /**
  *
  * @param {number} x
@@ -58,7 +58,7 @@ function functionWithClearName() {}
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /**
  * Non-empty description
  * @param {number} x

diff --git a/docs/rules/no-blank-blocks.md b/docs/rules/no-blank-blocks.md
@@ -39,7 +39,7 @@ Whether or not to auto-remove the blank block. Defaults to `false`.
 
 The following patterns are considered problems:
 
-````js
+````ts
 /** */
 // "jsdoc/no-blank-blocks": ["error"|"warn", {"enableFixer":true}]
 // Message: No empty blocks
@@ -84,7 +84,7 @@ The following patterns are considered problems:
 
 The following patterns are not considered problems:
 
-````js
+````ts
 /** @tag */
 
 /**