fix: Hidden module-namespaces

Fixes #1396
TypeStrong · Nov 25, 2020 · 88fa674 · 88fa674
1 parent fc1d58e
commit 88fa674
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts
@@ -195,7 +195,10 @@ export class Converter extends ChildableComponent<
         const wantedKinds: ts.SyntaxKind[] = {
             [ReflectionKind.Project]: [ts.SyntaxKind.SourceFile],
             [ReflectionKind.Module]: [ts.SyntaxKind.SourceFile],
-            [ReflectionKind.Namespace]: [ts.SyntaxKind.ModuleDeclaration],
+            [ReflectionKind.Namespace]: [
+                ts.SyntaxKind.ModuleDeclaration,
+                ts.SyntaxKind.SourceFile,
+            ],
             [ReflectionKind.Enum]: [ts.SyntaxKind.EnumDeclaration],
             [ReflectionKind.EnumMember]: [ts.SyntaxKind.EnumMember],
             [ReflectionKind.Variable]: [ts.SyntaxKind.VariableDeclaration],

diff --git a/src/lib/converter/plugins/CommentPlugin.ts b/src/lib/converter/plugins/CommentPlugin.ts
@@ -140,7 +140,9 @@ export class CommentPlugin extends ConverterComponent {
             comment.removeTags("event");
         }
 
-        if (reflection.kindOf(ReflectionKind.Module)) {
+        if (
+            reflection.kindOf(ReflectionKind.Module | ReflectionKind.Namespace)
+        ) {
             comment.removeTags("packagedocumentation");
         }
     }
@@ -274,10 +276,7 @@ export class CommentPlugin extends ConverterComponent {
         const project = context.project;
         const reflections = Object.values(project.reflections);
 
-        // remove signatures
-        // TODO: This doesn't really belong here. Removing comments due to @hidden yes, but private/protected no.
-        //   it needs to be here for now because users can use @public/@private/@protected to override visibility.
-        //   the converter should probably have a post resolve step in which it handles the excludePrivate/protected options.
+        // Remove hidden reflections
         const hidden = reflections.filter((reflection) =>
             CommentPlugin.isHidden(
                 reflection,