You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .README/rules/match-description.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,9 @@ by our supported Node versions):
8
8
9
9
``^([A-Z]|[`\\d_])[\\s\\S]*[.?!`]$``
10
10
11
+
Applies to the jsdoc block description and `@description` (or `@desc`)
12
+
by default but the `tags` option (see below) may be used to match other tags.
13
+
11
14
#### Options
12
15
13
16
##### `matchDescription`
@@ -50,8 +53,10 @@ tag should be linted with the `matchDescription` value (or the default).
50
53
}
51
54
```
52
55
53
-
The tags `@param`/`@arg`/`@argument` will be properly parsed to ensure that
54
-
the matched "description" text includes only the text after the name.
56
+
The tags `@param`/`@arg`/`@argument` and `@property`/`@prop` will be properly
57
+
parsed to ensure that the matched "description" text includes only the text
58
+
after the name.
59
+
55
60
All other tags will treat the text following the tag name, a space, and
56
61
an optional curly-bracketed type expression (and another space) as part of
57
62
its "description" (e.g., for `@returns {someType} some description`, the
@@ -88,8 +93,8 @@ Overrides the default contexts (see below).
88
93
|||
89
94
|---|---|
90
95
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
91
-
|Tags|N/A by default but see `tags` options|
96
+
|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
92
97
|Settings||
93
-
|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'description', 'desc', and any added to `tags` option, e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
98
+
|Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
@@ -2537,8 +2540,10 @@ tag should be linted with the `matchDescription` value (or the default).
2537
2540
}
2538
2541
```
2539
2542
2540
-
The tags `@param`/`@arg`/`@argument` will be properly parsed to ensure that
2541
-
the matched "description" text includes only the text after the name.
2543
+
The tags `@param`/`@arg`/`@argument` and `@property`/`@prop` will be properly
2544
+
parsed to ensure that the matched "description" text includes only the text
2545
+
after the name.
2546
+
2542
2547
All other tags will treat the text following the tag name, a space, and
2543
2548
an optional curly-bracketed type expression (and another space) as part of
2544
2549
its "description" (e.g., for `@returns {someType} some description`, the
@@ -2577,9 +2582,9 @@ Overrides the default contexts (see below).
2577
2582
|||
2578
2583
|---|---|
2579
2584
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
2580
-
|Tags|N/A by default but see `tags` options|
2585
+
|Tags|docblock and `@description` (or `@desc`) by default but more with `tags`|
2581
2586
|Settings||
2582
-
|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'description', 'desc', and any added to `tags` option, e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
2587
+
|Options|`contexts`, `tags` (accepts tags with names and optional type such as 'param', 'arg', 'argument', 'property', and 'prop', and accepts arbitrary list of other tags with an optional type (but without names), e.g., 'returns', 'return'), `mainDescription`, `matchDescription`|
0 commit comments