File tree Expand file tree Collapse file tree 4 files changed +8
-4
lines changed Expand file tree Collapse file tree 4 files changed +8
-4
lines changed Original file line number Diff line number Diff line change @@ -6,7 +6,7 @@ This rule checks for multi-line-style comments which fail to meet the
6
6
criteria of a JSDoc block, namely that it should begin with two and only two
7
7
asterisks, but which appear to be intended as JSDoc blocks due to the presence
8
8
of whitespace followed by whitespace or asterisks, and
9
- an at-sign (` @ ` ) and some non-whitespace (as with a jsdoc block tag).
9
+ an at-sign (` @ ` ) and some non-whitespace (as with a JSDoc block tag).
10
10
11
11
Exceptions are made for ESLint directive comments (which may use ` @ ` in
12
12
rule names).
Original file line number Diff line number Diff line change @@ -19,11 +19,13 @@ within it or your documentation.
19
19
### ` escapeHTML `
20
20
21
21
This option escapes all ` < ` and ` & ` characters (except those followed by
22
- whitespace which are treated as literals by Visual Studio Code).
22
+ whitespace which are treated as literals by Visual Studio Code). Defaults to
23
+ ` false ` .
23
24
24
25
### ` escapeMarkdown `
25
26
26
27
This option escapes the first backtick (`` ` `` ) in a paired sequence.
28
+ Defaults to ` false ` .
27
29
28
30
## Context and settings
29
31
Original file line number Diff line number Diff line change @@ -8,7 +8,7 @@ This rule checks for multi-line-style comments which fail to meet the
8
8
criteria of a JSDoc block, namely that it should begin with two and only two
9
9
asterisks, but which appear to be intended as JSDoc blocks due to the presence
10
10
of whitespace followed by whitespace or asterisks, and
11
- an at-sign (` @ ` ) and some non-whitespace (as with a jsdoc block tag).
11
+ an at-sign (` @ ` ) and some non-whitespace (as with a JSDoc block tag).
12
12
13
13
Exceptions are made for ESLint directive comments (which may use ` @ ` in
14
14
rule names).
Original file line number Diff line number Diff line change @@ -34,13 +34,15 @@ within it or your documentation.
34
34
### <code >escapeHTML</code >
35
35
36
36
This option escapes all ` < ` and ` & ` characters (except those followed by
37
- whitespace which are treated as literals by Visual Studio Code).
37
+ whitespace which are treated as literals by Visual Studio Code). Defaults to
38
+ ` false ` .
38
39
39
40
<a name =" user-content-text-escaping-options-escapemarkdown " ></a >
40
41
<a name =" text-escaping-options-escapemarkdown " ></a >
41
42
### <code >escapeMarkdown</code >
42
43
43
44
This option escapes the first backtick (`` ` `` ) in a paired sequence.
45
+ Defaults to ` false ` .
44
46
45
47
<a name =" user-content-text-escaping-context-and-settings " ></a >
46
48
<a name =" text-escaping-context-and-settings " ></a >
You can’t perform that action at this time.
0 commit comments