Skip to content

Commit b3c6c02

Browse files
brettz9brettz9
committed
docs: update generated docs
1 parent 0973caf commit b3c6c02

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+112
-112
lines changed

‎docs/rules/check-access.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Also reports:
3636

3737
The following patterns are considered problems:
3838

39-
````js
39+
````ts
4040
/**
4141
* @access foo
4242
*/
@@ -145,7 +145,7 @@ function quux (foo) {
145145

146146
The following patterns are not considered problems:
147147

148-
````js
148+
````ts
149149
/**
150150
*
151151
*/

‎docs/rules/check-alignment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Fixes alignment.
3232

3333
The following patterns are considered problems:
3434

35-
````js
35+
````ts
3636
/**
3737
* @param {Number} foo
3838
*/
@@ -120,7 +120,7 @@ class Foo {
120120

121121
The following patterns are not considered problems:
122122

123-
````js
123+
````ts
124124
/**
125125
* Desc
126126
*

‎docs/rules/check-examples.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ expression-oriented rules will be used by default as well:
220220

221221
The following patterns are considered problems:
222222

223-
````js
223+
````ts
224224
/**
225225
* @example alert('hello')
226226
*/
@@ -563,7 +563,7 @@ const functionName = function (paramOne, paramTwo,
563563

564564
The following patterns are not considered problems:
565565

566-
````js
566+
````ts
567567
/**
568568
* @example ```js
569569
alert('hello');

‎docs/rules/check-indentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ report a padding issue:
7272

7373
The following patterns are considered problems:
7474

75-
````js
75+
````ts
7676
/** foo */
7777
function quux () {
7878

@@ -188,7 +188,7 @@ function quux () {
188188

189189
The following patterns are not considered problems:
190190

191-
````js
191+
````ts
192192
/**
193193
* foo
194194
*

‎docs/rules/check-line-alignment.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Disables `wrapIndent`; existing wrap indentation is preserved without changes.
9797

9898
The following patterns are considered problems:
9999

100-
````js
100+
````ts
101101
/**
102102
* Function description.
103103
*
@@ -582,7 +582,7 @@ function quux () {}
582582

583583
The following patterns are not considered problems:
584584

585-
````js
585+
````ts
586586
/**
587587
* Function description.
588588
*

‎docs/rules/check-param-names.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Whether to avoid checks for missing `@param` definitions. Defaults to `false`. C
141141

142142
The following patterns are considered problems:
143143

144-
````js
144+
````ts
145145
/**
146146
* @param Foo
147147
*/
@@ -691,7 +691,7 @@ export function fn(...[type, arg]: FnArgs): void {
691691

692692
The following patterns are not considered problems:
693693

694-
````js
694+
````ts
695695
/**
696696
*
697697
*/

‎docs/rules/check-property-names.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ be removed even if it has a different type or description).
5252

5353
The following patterns are considered problems:
5454

55-
````js
55+
````ts
5656
/**
5757
* @typedef (SomeType) SomeTypedef
5858
* @property Foo.Bar
@@ -175,7 +175,7 @@ function quux ({foo, bar}, baz) {
175175

176176
The following patterns are not considered problems:
177177

178-
````js
178+
````ts
179179
/**
180180
*
181181
*/

‎docs/rules/check-syntax.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ rule is enforced (except under "permissive" and "closure" modes).
3636

3737
The following patterns are considered problems:
3838

39-
````js
39+
````ts
4040
/**
4141
* @param {string=} foo
4242
*/
@@ -54,7 +54,7 @@ function quux (foo) {
5454

5555
The following patterns are not considered problems:
5656

57-
````js
57+
````ts
5858
/**
5959
* @param {string=} foo
6060
*/

‎docs/rules/check-tag-names.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ this
322322

323323
The following patterns are considered problems:
324324

325-
````js
325+
````ts
326326
/** @type {string} */let a;
327327
// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
328328
// Message: '@type' is redundant when using a type system.
@@ -775,7 +775,7 @@ function quux () {
775775

776776
The following patterns are not considered problems:
777777

778-
````js
778+
````ts
779779
/** @default 0 */
780780
let a;
781781
// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]

‎docs/rules/check-types.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ permitted.
192192

193193
The following patterns are considered problems:
194194

195-
````js
195+
````ts
196196
/**
197197
* @param {abc} foo
198198
*/
@@ -856,7 +856,7 @@ function a () {}
856856

857857
The following patterns are not considered problems:
858858

859-
````js
859+
````ts
860860
/**
861861
* @param {number} foo
862862
* @param {Bar} bar

‎docs/rules/check-values.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to
8888

8989
The following patterns are considered problems:
9090

91-
````js
91+
````ts
9292
/**
9393
* @version
9494
*/
@@ -270,7 +270,7 @@ function quux (foo) {
270270

271271
The following patterns are not considered problems:
272272

273-
````js
273+
````ts
274274
/**
275275
* @version 3.4.1
276276
*/

‎docs/rules/convert-to-jsdoc-comments.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Defaults to `VariableDeclarator`, `TSPropertySignature`, `PropertyDefinition`.
100100

101101
The following patterns are considered problems:
102102

103-
````js
103+
````ts
104104
// A single line comment
105105
function quux () {}
106106
// "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}]
@@ -211,7 +211,7 @@ var a = []; // Test comment
211211

212212
The following patterns are not considered problems:
213213

214-
````js
214+
````ts
215215
/** A single line comment */
216216
function quux () {}
217217
// "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}]

‎docs/rules/empty-tags.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ add them within this option.
7575

7676
The following patterns are considered problems:
7777

78-
````js
78+
````ts
7979
/**
8080
* @abstract extra text
8181
*/
@@ -153,7 +153,7 @@ function quux () {
153153

154154
The following patterns are not considered problems:
155155

156-
````js
156+
````ts
157157
/**
158158
* @abstract
159159
*/

‎docs/rules/implements-on-classes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ section of our README for more on the expected format.
5555

5656
The following patterns are considered problems:
5757

58-
````js
58+
````ts
5959
/**
6060
* @implements {SomeClass}
6161
*/
@@ -136,7 +136,7 @@ class Foo {
136136

137137
The following patterns are not considered problems:
138138

139-
````js
139+
````ts
140140
/**
141141
* @implements {SomeClass}
142142
* @class

‎docs/rules/imports-as-dependencies.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ which is not listed in `dependencies` or `devDependencies`.
1919

2020
The following patterns are considered problems:
2121

22-
````js
22+
````ts
2323
/**
2424
* @type {null|import('sth').SomeApi}
2525
*/
@@ -50,7 +50,7 @@ The following patterns are considered problems:
5050

5151
The following patterns are not considered problems:
5252

53-
````js
53+
````ts
5454
/**
5555
* @type {null|import('eslint').ESLint}
5656
*/

‎docs/rules/informative-docs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The default `uselessWords` option is:
102102

103103
The following patterns are considered problems:
104104

105-
````js
105+
````ts
106106
/** the */
107107
let myValue = 3;
108108
// Message: This description only repeats the name it describes.
@@ -300,7 +300,7 @@ export default function packageNameFromPath(path) {
300300

301301
The following patterns are not considered problems:
302302

303-
````js
303+
````ts
304304
/** */
305305
let myValue = 3;
306306

‎docs/rules/match-description.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ section of our README for more on the expected format.
216216

217217
The following patterns are considered problems:
218218

219-
````js
219+
````ts
220220
/**
221221
* foo.
222222
*/
@@ -633,7 +633,7 @@ function quux () {
633633

634634
The following patterns are not considered problems:
635635

636-
````js
636+
````ts
637637
/**
638638
*
639639
*/

‎docs/rules/match-name.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ be applied, however.
8282

8383
The following patterns are considered problems:
8484

85-
````js
85+
````ts
8686
/**
8787
* @param opt_a
8888
* @param opt_b
@@ -194,7 +194,7 @@ function quux () {}
194194

195195
The following patterns are not considered problems:
196196

197-
````js
197+
````ts
198198
/**
199199
* @param opt_a
200200
* @param opt_b

‎docs/rules/multiline-blocks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ cannot be reliably added after the tag either).
128128

129129
The following patterns are considered problems:
130130

131-
````js
131+
````ts
132132
/** Reported up here
133133
* because the rest is multiline
134134
*/
@@ -293,7 +293,7 @@ The following patterns are considered problems:
293293

294294
The following patterns are not considered problems:
295295

296-
````js
296+
````ts
297297
/** Not reported */
298298

299299
/**

‎docs/rules/no-bad-blocks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ apparent tag content.
5757

5858
The following patterns are considered problems:
5959

60-
````js
60+
````ts
6161
/*
6262
* @param foo
6363
*/
@@ -117,7 +117,7 @@ function quux (foo) {
117117

118118
The following patterns are not considered problems:
119119

120-
````js
120+
````ts
121121
/**
122122
* @property foo
123123
*/

‎docs/rules/no-blank-block-descriptions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ in the block description.
3434

3535
The following patterns are considered problems:
3636

37-
````js
37+
````ts
3838
/**
3939
*
4040
* @param {number} x
@@ -58,7 +58,7 @@ function functionWithClearName() {}
5858

5959
The following patterns are not considered problems:
6060

61-
````js
61+
````ts
6262
/**
6363
* Non-empty description
6464
* @param {number} x

‎docs/rules/no-blank-blocks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Whether or not to auto-remove the blank block. Defaults to `false`.
3939

4040
The following patterns are considered problems:
4141

42-
````js
42+
````ts
4343
/** */
4444
// "jsdoc/no-blank-blocks": ["error"|"warn", {"enableFixer":true}]
4545
// Message: No empty blocks
@@ -84,7 +84,7 @@ The following patterns are considered problems:
8484

8585
The following patterns are not considered problems:
8686

87-
````js
87+
````ts
8888
/** @tag */
8989

9090
/**

0 commit comments

Comments
 (0)