feat: Support for @module tag

TypeStrong · Nov 26, 2020 · 15cb73c · 15cb73c
1 parent ef41514
commit 15cb73c
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -226,6 +226,14 @@ export class CommentPlugin extends ConverterComponent {
             this.removeExcludedTags(comment);
             reflection.comment = comment;
         }
+
+        if (reflection.kindOf(ReflectionKind.Module)) {
+            const tag = reflection.comment?.getTag("module");
+            if (tag) {
+                reflection.name = tag.text.trim();
+                removeIfPresent(reflection.comment?.tags, tag);
+            }
+        }
     }
 
     /**

diff --git a/src/test/converter/class/clodule-with-subclass.ts b/src/test/converter/class/clodule-with-subclass.ts
@@ -1,3 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module clodule
+ */
+
 // see https://github.com/TypeStrong/typedoc/issues/869
 export class Foo {}
 export namespace Foo {

diff --git a/src/test/converter/class/specs-with-lump-categories.json b/src/test/converter/class/specs-with-lump-categories.json
@@ -1366,10 +1366,12 @@
     },
     {
       "id": 81,
-      "name": "clodule-with-subclass",
+      "name": "clodule",
       "kind": 1,
       "kindString": "Module",
       "flags": {},
+      "comment": {},
+      "originalName": "clodule-with-subclass",
       "children": [
         {
           "id": 85,

diff --git a/src/test/converter/class/specs.json b/src/test/converter/class/specs.json
@@ -1362,10 +1362,12 @@
     },
     {
       "id": 81,
-      "name": "clodule-with-subclass",
+      "name": "clodule",
       "kind": 1,
       "kindString": "Module",
       "flags": {},
+      "comment": {},
+      "originalName": "clodule-with-subclass",
       "children": [
         {
           "id": 85,