Add support for @hideconstructor

Resolves #2557

Author: Gerrit0

CHANGELOG.md

@@ -45,6 +45,8 @@
 -   New option, `--customFooterHtml` to add custom HTML to the generated page footer, #2559.
 -   TypeDoc will now copy modifier tags to children if specified in the `--cascadedModifierTags` option, #2056.
 -   TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both `@alpha` and `@beta`), #2056.
+-   Added support for JSDoc `@hideconstructor` tag.
+    This tag should only be used to work around TypeScript#58653, prefer the more general `@hidden`/`@ignore` tag to hide members normally, #2577.
 -   TypeDoc will now warn if a block tag is used which is not defined by the `--blockTags` option.
 -   Added three new sort strategies `documents-first`, `documents-last`, and `alphabetical-ignoring-documents` to order markdown documents.
 -   Added new `--alwaysCreateEntryPointModule` option. When set, TypeDoc will always create a `Module` for entry points, even if only one is provided.

src/lib/converter/plugins/CommentPlugin.ts

@@ -393,6 +393,13 @@ export class CommentPlugin extends ConverterComponent {
 
             mergeSeeTags(reflection.comment);
             movePropertyTags(reflection.comment, reflection);
+
+            // Unlike other modifiers, this one has to wait until resolution to be removed
+            // as it needs to remain present so that it can be checked when `@hidden` tags are
+            // being processed.
+            if (reflection.kindOf(ReflectionKind.Class)) {
+                reflection.comment.removeModifier("@hideconstructor");
+            }
         }
 
         if (reflection instanceof DeclarationReflection && reflection.comment) {
@@ -540,6 +547,23 @@ export class CommentPlugin extends ConverterComponent {
             return true;
         }
 
+        if (
+            reflection.kindOf(
+                ReflectionKind.ConstructorSignature |
+                    ReflectionKind.Constructor,
+            )
+        ) {
+            if (comment?.hasModifier("@hideconstructor")) return true;
+            const cls = reflection.parent?.kindOf(ReflectionKind.Class)
+                ? reflection.parent
+                : reflection.parent?.parent?.kindOf(ReflectionKind.Class)
+                  ? reflection.parent.parent
+                  : undefined;
+            if (cls?.comment?.hasModifier("@hideconstructor")) {
+                return true;
+            }
+        }
+
         if (!comment) {
             // We haven't moved comments from the parent for signatures without a direct
             // comment, so don't exclude those due to not being documented.

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

@@ -70,4 +70,5 @@ export const modifierTags = [
     "@overload",
     "@showCategories",
     "@showGroups",
+    "@hideconstructor",
 ] as const;

src/test/behavior.c2.test.ts

@@ -580,6 +580,14 @@ describe("Behavior Tests", () => {
         );
     });
 
+    it("Handles @hideconstructor", () => {
+        const project = convert("hideconstructor");
+
+        ok(!project.getChildByName("StaticOnly.constructor"));
+        ok(!!project.getChildByName("StaticOnly.notHidden"));
+        ok(!project.getChildByName("IgnoredCtor.constructor"));
+    });
+
     it("Handles simple @inheritDoc cases", () => {
         const project = convert("inheritDocBasic");
         const target = query(project, "InterfaceTarget");

src/test/converter2/behavior/externalSymbols.ts

@@ -1,4 +1,4 @@
-import { Token, ParseResult } from "markdown-it";
+import { Token, ParseLinkTitleResult } from "markdown-it";
 
 /**
  * Testing custom external link resolution
@@ -7,4 +7,4 @@ import { Token, ParseResult } from "markdown-it";
 export type P = Promise<string>;
 
 export declare const T: Token;
-export declare const Pr: ParseResult;
+export declare const Pr: ParseLinkTitleResult;

src/test/converter2/behavior/hideconstructor.ts

@@ -0,0 +1,14 @@
+// https://github.com/TypeStrong/typedoc/issues/2577
+
+/** @hideconstructor */
+export class StaticOnly {
+    static foo() {}
+
+    /** @hideconstructor */
+    notHidden = true;
+}
+
+export class IgnoredCtor {
+    /** @hideconstructor */
+    constructor() {}
+}

tsdoc.json

@@ -142,6 +142,10 @@
         {
             "tagName": "@hideGroups",
             "syntaxKind": "modifier"
+        },
+        {
+            "tagName": "@hideconstructor",
+            "syntaxKind": "modifier"
         }
     ]
 }