Merge pull request #138 from docsbydoxdox/hotfix/api-private-tag

[hotfix] Added support for api private tag in Jsdoc.

Author: neogeek

packages/doxdox-parser-jsdoc/src/index.ts

@@ -52,6 +52,14 @@ export default async (cwd: string, path: string): Promise<File> => {
                     })
                 );
 
+                const isPrivate =
+                    jsdoc.access === 'private' ||
+                    (jsdoc.tags &&
+                        jsdoc.tags.findIndex(
+                            tag =>
+                                tag.title === 'api' && tag.value === 'private'
+                        )) !== -1;
+
                 return {
                     slug: `${slugify(path)}-${slugify(jsdoc.name)}`,
                     name: jsdoc.name,
@@ -62,7 +70,7 @@ export default async (cwd: string, path: string): Promise<File> => {
                     description: jsdoc.description || '',
                     params,
                     returns,
-                    private: jsdoc.access === 'private'
+                    private: isPrivate
                 };
             })
             .sort((a, b) => {

packages/doxdox-parser-jsdoc/src/types.ts

@@ -2,12 +2,18 @@ export interface Jsdoc {
     kind: string;
     name: string;
     description: string;
+    tags?: JsdocTag[];
     params: JsdocParam[];
     returns: JsdocParam[];
     access: string;
     undocumented?: boolean;
 }
 
+export interface JsdocTag {
+    title: string;
+    value: string;
+}
+
 export interface JsdocParam {
     name?: string;
     description: string;