This repository was archived by the owner on Oct 26, 2025. It is now read-only.
Add custom tag definitions for TSDoc #219
Unanswered
fussel178
asked this question in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Found something out this evening:
When you want custom tags in TSDoc, but the tsdoc eslint plugin won't let you, you can define a
tsdoc.jsonbeside thetsconfig.jsonin your project that gets passed to the eslint config.In there you can define your own tags and much more (according to their documentation 😂):
https://www.npmjs.com/package/@microsoft/tsdoc-config
An example config could look like:
{ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "tagDefinitions": [ { "tagName": "@preserve", "syntaxKind": "modifier" } ] }Beta Was this translation helpful? Give feedback.
All reactions