Implemented '--excludeProtected' option similar to the '--excludePriv… (TypeStrong#666)

Implemented '--excludeProtected' option similar to the '--excludePrivate' option.

Author: shabbir-genetech

README.md

@@ -67,6 +67,8 @@ in order to change the behaviour of TypeDoc.
   Prevent externally resolved TypeScript files from being documented.
 * `--excludePrivate`<br>
   Prevent private members from being included in the generated documentation.
+* `--excludeProtected`<br>
+  Prevent protected members from being included in the generated documentation.
 
 #### TypeScript compiler
 * `--module <commonjs, amd, system or umd>`<br>

src/lib/converter/converter.ts

@@ -74,6 +74,13 @@ export class Converter extends ChildableComponent<Application, ConverterComponen
     })
     excludePrivate: boolean;
 
+    @Option({
+        name: 'excludeProtected',
+        help: 'Ignores protected variables and methods',
+        type: ParameterType.Boolean
+    })
+    excludeProtected: boolean;
+
     private compilerHost: CompilerHost;
 
     private nodeConverters: {[syntaxKind: number]: ConverterNodeComponent<ts.Node>};

src/lib/converter/nodes/class.ts

@@ -40,7 +40,9 @@ export class ClassConverter extends ConverterNodeComponent<ts.ClassDeclaration>
                 node.members.forEach((member) => {
                     const modifiers = ts.getCombinedModifierFlags(member);
                     const privateMember = (modifiers & ts.ModifierFlags.Private) > 0;
-                    const exclude = context.converter.excludePrivate ? privateMember : false;
+                    const protectedMember = (modifiers & ts.ModifierFlags.Protected) > 0;
+                    const exclude = (context.converter.excludePrivate && privateMember)
+                        || (context.converter.excludeProtected && protectedMember);
 
                     if (!exclude) {
                         this.owner.convertNode(context, member);

src/lib/converter/nodes/constructor.ts

@@ -73,6 +73,11 @@ export class ConstructorConverter extends ConverterNodeComponent<ts.ConstructorD
             return;
         }
 
+        const protectedParameter = modifiers & ts.ModifierFlags.Protected;
+        if (protectedParameter && context.converter.excludeProtected) {
+            return;
+        }
+
         const property = createDeclaration(context, parameter, ReflectionKind.Property);
         if (!property) {
             return;

src/test/renderer/specs/index.html

@@ -118,6 +118,8 @@ <h4 id="source-file-handling">Source file handling</h4>
 					Prevent externally resolved TypeScript files from being documented.</li>
 					<li><code>--excludePrivate</code><br>
 					Prevent private members from being included in the generated documentation.</li>
+					<li><code>--excludeProtected</code><br>
+					Prevent protected members from being included in the generated documentation.</li>
 				</ul>
 				<h4 id="typescript-compiler">TypeScript compiler</h4>
 				<ul>