Do not attach module comments to non-modules

TypeStrong · Jun 4, 2022 · f57c812 · f57c812
1 parent 7918fba
commit f57c812
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 78 deletions.
diff --git a/src/lib/converter/comments/index.ts b/src/lib/converter/comments/index.ts
@@ -77,6 +77,16 @@ export function getComment(
         }
     }
 
+    if (!symbol.declarations?.some(ts.isSourceFile) && comment) {
+        // Ensure module comments are not attached to non-module reflections.
+        if (
+            comment.hasModifier("@packageDocumentation") ||
+            comment.getTag("@module")
+        ) {
+            return;
+        }
+    }
+
     return comment;
 }
 

diff --git a/src/test/converter/exports/specs.json b/src/test/converter/exports/specs.json
@@ -888,29 +888,6 @@
           "flags": {
             "isConst": true
           },
-          "comment": {
-            "summary": [
-              {
-                "kind": "text",
-                "text": "This module has documentation, but no exported members do."
-              }
-            ],
-            "blockTags": [
-              {
-                "tag": "@see",
-                "content": [
-                  {
-                    "kind": "text",
-                    "text": "https://github.com/TypeStrong/typedoc/issues/1948"
-                  }
-                ]
-              },
-              {
-                "tag": "@module",
-                "content": []
-              }
-            ]
-          },
           "sources": [
             {
               "fileName": "no-doc-members.ts",

diff --git a/src/test/converter/exports/specs.nodoc.json b/src/test/converter/exports/specs.nodoc.json
@@ -255,61 +255,6 @@
           }
         ]
       },
-      "children": [
-        {
-          "id": 39,
-          "name": "abc",
-          "kind": 32,
-          "kindString": "Variable",
-          "flags": {
-            "isConst": true
-          },
-          "comment": {
-            "summary": [
-              {
-                "kind": "text",
-                "text": "This module has documentation, but no exported members do."
-              }
-            ],
-            "blockTags": [
-              {
-                "tag": "@see",
-                "content": [
-                  {
-                    "kind": "text",
-                    "text": "https://github.com/TypeStrong/typedoc/issues/1948"
-                  }
-                ]
-              },
-              {
-                "tag": "@module",
-                "content": []
-              }
-            ]
-          },
-          "sources": [
-            {
-              "fileName": "no-doc-members.ts",
-              "line": 6,
-              "character": 13,
-              "url": "https://github.com/TypeStrong/typedoc/blob/fake/src/test/converter/exports/no-doc-members.ts#L6"
-            }
-          ],
-          "type": {
-            "type": "literal",
-            "value": 123
-          },
-          "defaultValue": "123"
-        }
-      ],
-      "groups": [
-        {
-          "title": "Variables",
-          "children": [
-            39
-          ]
-        }
-      ],
       "sources": [
         {
           "fileName": "no-doc-members.ts",