Skip to content

Commit 3b6d18c

Browse files
committed
fix: Remove the packageDocumentation tag from comments
1 parent 13b56b9 commit 3b6d18c

File tree

2 files changed

+2
-8
lines changed

2 files changed

+2
-8
lines changed

src/lib/converter/plugins/CommentPlugin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export class CommentPlugin extends ConverterComponent {
121121
}
122122

123123
if (reflection.kindOf(ReflectionKind.ExternalModule)) {
124-
CommentPlugin.removeTags(comment, 'packageDocumentation');
124+
CommentPlugin.removeTags(comment, 'packagedocumentation');
125125
}
126126
}
127127

src/test/converter/comment/specs.json

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,7 @@
109109
},
110110
"originalName": "%BASE%/comment/comment2.ts",
111111
"comment": {
112-
"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.",
113-
"tags": [
114-
{
115-
"tag": "packagedocumentation",
116-
"text": "\n"
117-
}
118-
]
112+
"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."
119113
},
120114
"children": [
121115
{

0 commit comments

Comments
 (0)