Skip to content

Commit 5d44e12

Browse files
committed
document support for array of permitted tag names
1 parent a85149a commit 5d44e12

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

about-configuring-jsdoc.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,8 @@ <h2 id="tags-and-tag-dictionaries">Tags and tag dictionaries</h2>
218218
</code></pre>
219219
</figure>
220220
<p>The <code>tags.allowUnknownTags</code> property affects how JSDoc handles unrecognized tags. If you set this option to <code>false</code>, and JSDoc finds a
221-
tag that it does not recognize (for example, <code>@foo</code>), JSDoc logs a warning. By default, this option is set to <code>true</code>.</p>
221+
tag that it does not recognize (for example, <code>@foo</code>), JSDoc logs a warning. By default, this option is set to <code>true</code>. In JSDoc 3.4.1
222+
and later, you can also set this property to an array of tag names that JSDoc should allow (for example, <code>[&quot;foo&quot;,&quot;bar&quot;]</code>).</p>
222223
<p>The <code>tags.dictionaries</code> property controls which tags JSDoc recognizes, as well as how JSDoc interprets the tags that it recognizes. In JSDoc 3.3.0
223224
and later, there are two built-in tag dictionaries:
224225
</p>

content/en/about-configuring-jsdoc.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,8 @@ The options in `tags` control which JSDoc tags are allowed and how each tag is i
268268

269269
The `tags.allowUnknownTags` property affects how JSDoc handles unrecognized tags. If you set this
270270
option to `false`, and JSDoc finds a tag that it does not recognize (for example, `@foo`), JSDoc
271-
logs a warning. By default, this option is set to `true`.
271+
logs a warning. By default, this option is set to `true`. In JSDoc 3.4.1 and later, you can also
272+
set this property to an array of tag names that JSDoc should allow (for example, `["foo","bar"]`).
272273

273274
The `tags.dictionaries` property controls which tags JSDoc recognizes, as well as how JSDoc
274275
interprets the tags that it recognizes. In JSDoc 3.3.0 and later, there are two built-in tag

0 commit comments

Comments
 (0)