Support @extends tag

Resolves #2659
TypeStrong · Aug 9, 2024 · 48545c1 · 48545c1
1 parent e7d88ce
commit 48545c1
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Unreleased
 
+### Features
+
+-   Use of the `@extends` block tag no longer produces warnings, #2659.
+    This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
+
 ### Bug Fixes
 
 -   The `suppressCommentWarningsInDeclarationFiles` option now correctly ignores warnings in `.d.cts` and `.d.mts` files, #2647.

diff --git a/src/lib/utils/options/tsdoc-defaults.ts b/src/lib/utils/options/tsdoc-defaults.ts
@@ -21,6 +21,7 @@ export const blockTags = [
     "@categoryDescription",
     "@default",
     "@document",
+    "@extends",
     "@group",
     "@groupDescription",
     "@import",

diff --git a/tsdoc.json b/tsdoc.json
@@ -75,6 +75,10 @@
             "tagName": "@default",
             "syntaxKind": "block"
         },
+        {
+            "tagName": "@extends",
+            "syntaxKind": "block"
+        },
         {
             // TSDoc defines @returns, we also recognize @return for JSDoc compat
             "tagName": "@return",