File tree Expand file tree Collapse file tree 2 files changed +17
-13
lines changed Expand file tree Collapse file tree 2 files changed +17
-13
lines changed Original file line number Diff line number Diff line change 1
1
### ` require-file-overview `
2
2
3
- Requires that all files have a ` @file ` , ` @fileoverview ` , or ` @overview ` tag.
3
+ Checks that:
4
4
5
- Duplicate file overview tags will be reported as will file overview tags
6
- which are not, as per [ the docs] ( https://jsdoc.app/tags-file.html ) ,
7
- "at the beginning of the file", where beginning of the file is interpreted
8
- in this rule as being when the overview tag is not preceded by
9
- anything other than a comment.
5
+ 1 . All files have a ` @file ` , ` @fileoverview ` , or ` @overview ` tag.
6
+ 2 . Duplicate file overview tags within a given file will be reported
7
+ 3 . File overview tags will be reported which are not, as per
8
+ [ the docs] ( https://jsdoc.app/tags-file.html ) , "at the beginning of
9
+ the file"–where beginning of the file is interpreted in this rule
10
+ as being when the overview tag is not preceded by anything other than
11
+ a comment.
10
12
11
13
#### Fixer
12
14
Original file line number Diff line number Diff line change @@ -6197,13 +6197,15 @@ function quux () {
6197
6197
<a name=" eslint- plugin- jsdoc- rules- require- file- overview" ></a>
6198
6198
### <code>require-file-overview</code>
6199
6199
6200
- Requires that all files have a `@file`, `@fileoverview`, or `@overview` tag.
6201
-
6202
- Duplicate file overview tags will be reported as will file overview tags
6203
- which are not, as per [the docs](https://jsdoc.app/tags-file.html),
6204
- " at the beginning of the file" , where beginning of the file is interpreted
6205
- in this rule as being when the overview tag is not preceded by
6206
- anything other than a comment.
6200
+ Checks that:
6201
+
6202
+ 1. All files have a `@file`, `@fileoverview`, or `@overview` tag.
6203
+ 2. Duplicate file overview tags within a given file will be reported
6204
+ 3. File overview tags will be reported which are not, as per
6205
+ [the docs](https://jsdoc.app/tags-file.html), " at the beginning of
6206
+ the file" –where beginning of the file is interpreted in this rule
6207
+ as being when the overview tag is not preceded by anything other than
6208
+ a comment.
6207
6209
6208
6210
<a name=" eslint- plugin- jsdoc- rules- require- file- overview- fixer- 1 " ></a>
6209
6211
#### Fixer
You can’t perform that action at this time.
0 commit comments