From 48545c1ec5f2da85ce5c099771b8944719c38937 Mon Sep 17 00:00:00 2001 From: Gerrit Birkeland Date: Thu, 8 Aug 2024 20:02:11 -0600 Subject: [PATCH] Support `@extends` tag Resolves #2659 --- CHANGELOG.md | 5 +++++ src/lib/utils/options/tsdoc-defaults.ts | 1 + tsdoc.json | 4 ++++ 3 files changed, 10 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b6a827521..14372ba8e 100644 --- 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 index 17a7e23c9..776a71ef4 100644 --- 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 index 9bed22577..4b6f9f557 100644 --- 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",