feat: Allow excluding tags from comments

Closes #815

Author: Gerrit0

src/lib/converter/plugins/CommentPlugin.ts

@@ -15,6 +15,7 @@ import { Converter } from '../converter';
 import { Context } from '../context';
 import { partition, uniq } from 'lodash';
 import { SourceReference } from '../../models';
+import { BindOption } from '../../utils';
 
 /**
  * These tags are not useful to display in the generated documentation.
@@ -64,6 +65,9 @@ interface ModuleComment {
  */
 @Component({name: 'comment'})
 export class CommentPlugin extends ConverterComponent {
+    @BindOption('excludeTags')
+    excludeTags!: string[];
+
     /**
      * List of discovered module comments.
      * Defined in this.onBegin
@@ -194,13 +198,13 @@ export class CommentPlugin extends ConverterComponent {
         if (reflection.kindOf(ReflectionKind.FunctionOrMethod) || (reflection.kindOf(ReflectionKind.Event) && reflection['signatures'])) {
             const comment = parseComment(rawComment, reflection.comment);
             this.applyModifiers(reflection, comment);
-            this.removeBlacklistedTags(comment);
+            this.removeExcludedTags(comment);
         } else if (reflection.kindOf(ReflectionKind.Module)) {
             this.storeModuleComment(rawComment, reflection);
         } else {
             const comment = parseComment(rawComment, reflection.comment);
             this.applyModifiers(reflection, comment);
-            this.removeBlacklistedTags(comment);
+            this.removeExcludedTags(comment);
             reflection.comment = comment;
         }
     }
@@ -327,10 +331,13 @@ export class CommentPlugin extends ConverterComponent {
         }
     }
 
-    private removeBlacklistedTags(comment: Comment) {
+    private removeExcludedTags(comment: Comment) {
         for (const tag of TAG_BLACKLIST) {
             comment.removeTags(tag);
         }
+        for (const tag of this.excludeTags) {
+            comment.removeTags(tag);
+        }
     }
 
     /**

src/lib/utils/options/declaration.ts

@@ -62,6 +62,7 @@ export interface TypeDocOptionMap {
     theme: string;
     name: string;
     includeVersion: boolean;
+    excludeTags: string[];
     readme: string;
     defaultCategory: string;
     categoryOrder: string[];

src/lib/utils/options/sources/typedoc.ts

@@ -110,9 +110,14 @@ export function addTypeDocOptions(options: Options) {
     });
     options.addDeclaration({
         name: 'includeVersion',
-        help: 'Add the package version to the project name',
+        help: 'Add the package version to the project name.',
         type: ParameterType.Boolean
     });
+    options.addDeclaration({
+        name: 'excludeTags',
+        help: 'Remove the listed tags from doc comments.',
+        type: ParameterType.Array
+    });
     options.addDeclaration({
         name: 'readme',
         help: 'Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.'