Skip to content

Commit b3c6c02

Browse files
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

0 commit comments

Comments
 (0)