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
66criteria of a JSDoc block, namely that it should begin with two and only two
77asterisks, but which appear to be intended as JSDoc blocks due to the presence
88of 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).
1010
1111Exceptions are made for ESLint directive comments (which may use ` @ ` in
1212rule names).
Original file line number Diff line number Diff line change @@ -19,11 +19,13 @@ within it or your documentation.
1919### ` escapeHTML `
2020
2121This 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 ` .
2324
2425### ` escapeMarkdown `
2526
2627This option escapes the first backtick (`` ` `` ) in a paired sequence.
28+ Defaults to ` false ` .
2729
2830## Context and settings
2931
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
88criteria of a JSDoc block, namely that it should begin with two and only two
99asterisks, but which appear to be intended as JSDoc blocks due to the presence
1010of 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).
1212
1313Exceptions are made for ESLint directive comments (which may use ` @ ` in
1414rule names).
Original file line number Diff line number Diff line change @@ -34,13 +34,15 @@ within it or your documentation.
3434### <code >escapeHTML</code >
3535
3636This 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 ` .
3839
3940<a name =" user-content-text-escaping-options-escapemarkdown " ></a >
4041<a name =" text-escaping-options-escapemarkdown " ></a >
4142### <code >escapeMarkdown</code >
4243
4344This option escapes the first backtick (`` ` `` ) in a paired sequence.
45+ Defaults to ` false ` .
4446
4547<a name =" user-content-text-escaping-context-and-settings " ></a >
4648<a name =" text-escaping-context-and-settings " ></a >
You can’t perform that action at this time.
0 commit comments