Merge pull request #2693 from waynemwashuma/master

Added support for `@abstract` tag

Author: Gerrit0

Diff for: CHANGELOG.md

@@ -5,6 +5,7 @@
 -   Added `customJs` option to include a script tag in generated HTML output, #2650.
 -   Added `markdownLinkExternal` option to treat `http[s]://` links in markdown documents and comments as external to be opened in a new tab, #2679.
 -   Added `navigation.excludeReferences` option to prevent re-exports from appearing in the left hand navigation, #2685.
+-   Added support for the `@abstract` tag, #2692.
 
 ### Bug Fixes
 
@@ -17,6 +18,7 @@
 ### Thanks!
 
 -   @Aryakoste
+-   @waynemwashuma
 
 ## v0.26.6 (2024-08-18)
 

Diff for: src/lib/converter/plugins/CommentPlugin.ts

@@ -192,6 +192,15 @@ export class CommentPlugin extends ConverterComponent {
             comment.removeModifier("@interface");
         }
 
+        if (comment.hasModifier("@abstract")) {
+            if (reflection.kindOf(ReflectionKind.SomeSignature)) {
+                reflection.parent!.setFlag(ReflectionFlag.Abstract);
+            } else {
+                reflection.setFlag(ReflectionFlag.Abstract);
+            }
+            comment.removeModifier("@abstract");
+        }
+
         if (comment.hasModifier("@private")) {
             reflection.setFlag(ReflectionFlag.Private);
             if (reflection.kindOf(ReflectionKind.CallSignature)) {

Diff for: src/lib/utils/options/tsdoc-defaults.ts

@@ -64,6 +64,7 @@ export const tsdocModifierTags = [
 
 export const modifierTags = [
     ...tsdocModifierTags,
+    "@abstract",
     "@class",
     "@enum",
     "@event",

Diff for: src/test/converter2/issues/gh2693.ts

@@ -0,0 +1,14 @@
+export abstract class Foo {
+    abstract foo(): void;
+
+    abstract x: number;
+}
+
+/** @abstract */
+export class Bar {
+    /** @abstract */
+    foo() {}
+
+    /** @abstract */
+    x!: number;
+}

Diff for: src/test/issues.c2.test.ts

@@ -1708,6 +1708,17 @@ describe("Issue Tests", () => {
         equal(data2.comment, undefined);
     });
 
+    it("#2693 handles the @abstract tag", () => {
+        const project = convert();
+        ok(query(project, "Foo.foo").flags.isAbstract);
+        ok(!querySig(project, "Foo.foo").flags.isAbstract);
+        ok(query(project, "Foo.x").flags.isAbstract);
+
+        ok(query(project, "Bar.foo").flags.isAbstract);
+        ok(!querySig(project, "Bar.foo").flags.isAbstract);
+        ok(query(project, "Bar.x").flags.isAbstract);
+    });
+
     it("#2698 handles this parameters present in type but not node", () => {
         const project = convert();
         const animator = querySig(project, "animator");

Diff for: tsdoc.json

@@ -67,6 +67,10 @@
             "tagName": "@class",
             "syntaxKind": "modifier"
         },
+        {
+            "tagName": "@abstract",
+            "syntaxKind": "modifier"
+        },
         {
             "tagName": "@document",
             "syntaxKind": "block"