Add @description to the default list of recognized tags

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 -   `mailto:` links are no longer incorrectly recognized as relative paths, #2613.
 -   Added `@since` to the default list of recognized tags, #2614.
+-   Added `@description` to the default list of recognized tags, #2618
 -   Relative paths to directories will no longer cause the directory to be copied into the media directory, #2617.
 
 ## v0.26.2 (2024-06-24)

src/lib/utils/options/tsdoc-defaults.ts

@@ -20,6 +20,7 @@ export const blockTags = [
     "@category",
     "@categoryDescription",
     "@default",
+    "@description",
     "@document",
     "@group",
     "@groupDescription",

src/test/converter2/issues/gh2618.ts

@@ -0,0 +1,5 @@
+/**
+ * Foo
+ * @description Bar
+ */
+export function foo() {}

src/test/issues.c2.test.ts

@@ -1636,4 +1636,15 @@ describe("Issue Tests", () => {
 
         logger.expectNoOtherMessages();
     });
+
+    it("#2618 supports @description tag", () => {
+        const project = convert();
+        const foo = querySig(project, "foo");
+        equal(
+            foo.comment?.getTag("@description"),
+            new CommentTag("@description", [{ kind: "text", text: "Bar" }]),
+        );
+
+        logger.expectNoOtherMessages();
+    });
 });

tsdoc.json

@@ -75,6 +75,10 @@
             "tagName": "@default",
             "syntaxKind": "block"
         },
+        {
+            "tagName": "@description",
+            "syntaxKind": "block"
+        },
         {
             // TSDoc defines @returns, we also recognize @return for JSDoc compat
             "tagName": "@return",