TypeDoc tag to specify version in which feature introduced

186 Views Asked by At

Does TypeDoc support any specific tag for identifying in which version the feature was introduced?

And if not, then what is the recommended way of adding such a detail?

1

There are 1 best solutions below

2
Gerrit0 On

TypeDoc does not specify a @version tag in its set of default tags. However, it does provide the blockTags option which can be used to tell TypeDoc to parse additional tags.

You could set this from your TypeDoc config, but it is probably better to create a tsdoc.json file which extends the base TypeDoc configuration.

{
  "extends": ["typedoc/tsdoc.json"],
  "tagDefinitions": [
    {
      "tagName": "@version",
      "syntaxKind": "block"
    }
  ]
}