Skip to content

Commit 73a1b5a

Browse files
author
Alexej Yaroshevich
committed
Docs: update tag values section
1 parent fbf8ac8 commit 73a1b5a

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,23 @@ There are 3 presets for `Closure Compiler`, `JSDoc3` and `JSDuck5`.
7373

7474
By default it allows any tag of mixed set. You can pass `Object` to select preset with `preset` field and add custom tags with `extra` field.
7575

76-
Type: `Boolean` or `String` or `{"preset": String, "extra": Object}` (`extra` field should contains tags in keys and boolean in values. false means no value possible)
76+
Type: `Boolean` or `String` or `{"preset": String, "extra": Object}` (see [tag values](#user-content-tag-values))
7777

7878
Values: `true`, `"closurecompiler"`, `"jsdoc3"`, `"jsduck5"`, `Object`
7979

8080
Context: `file`
8181

8282
Tags: `*`
8383

84+
#### Tag values
85+
86+
`extra` field should contains tags in keys and there are options for values:
87+
- `false` means tag available with no value
88+
- `true` means tag available with any value
89+
- `"some"` means tag available and requires some value
90+
91+
See also [tag presets](https://github.com/jscs-dev/jscs-jsdoc/tree/hotfix/check-annotations-rework/lib/tags).
92+
8493
#### Example
8594

8695
```js

0 commit comments

Comments
 (0)