fix: Remove the packageDocumentation tag from comments

TypeStrong · Dec 26, 2019 · 7cdc550 · 7cdc550
1 parent ef9ef6c
commit 7cdc550
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 8 deletions.
diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -121,7 +121,7 @@ export class CommentPlugin extends ConverterComponent {
         }
 
         if (reflection.kindOf(ReflectionKind.ExternalModule)) {
-            CommentPlugin.removeTags(comment, 'packageDocumentation');
+            CommentPlugin.removeTags(comment, 'packagedocumentation');
         }
     }
 

diff --git a/src/test/converter/comment/specs.json b/src/test/converter/comment/specs.json
@@ -109,13 +109,7 @@
       },
       "originalName": "%BASE%/comment/comment2.ts",
       "comment": {
-        "shortText": "This is a module doc with the packageDocumentation tag to mark it as documentation\nfor the whole module. It is *not* documentation for the `multiply` function.",
-        "tags": [
-          {
-            "tag": "packagedocumentation",
-            "text": "\n"
-          }
-        ]
+        "shortText": "This is a module doc with the packageDocumentation tag to mark it as documentation\nfor the whole module. It is *not* documentation for the `multiply` function."
       },
       "children": [
         {
-Original file line number
+Diff line change
@@ Expand Up / @@ -121,7 +121,7 @@ export class CommentPlugin extends ConverterComponent { @@
             }
             if (reflection.kindOf(ReflectionKind.ExternalModule)) {
-                CommentPlugin.removeTags(comment, 'packageDocumentation');
+                CommentPlugin.removeTags(comment, 'packagedocumentation');
             }
         }
@@ Expand Down @@