Doc comment

Author: Gerrit0

src/lib/converter/plugins/CommentPlugin.ts

@@ -46,8 +46,28 @@ const NEVER_RENDERED = [
 ] as const;
 
 /**
- * A handler that parses TypeDoc comments and attaches {@link Comment} instances to
- * the generated reflections.
+ * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
+ *
+ * During conversion:
+ * - Handle visibility flags (`@private`, `@protected`. `@public`)
+ * - Handle module renames (`@module`)
+ * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
+ * - Copy comments for type parameters from the parent container
+ *
+ * Resolve begin:
+ * - Remove hidden reflections
+ *
+ * Resolve:
+ * - Apply `@label` tag
+ * - Copy comments on signature containers to the signature if signatures don't already have a comment
+ *   and then remove the comment on the container.
+ * - Copy comments from signatures to parameters and type parameters (again? why?)
+ * - Apply `@group` and `@category` tags
+ *
+ * Resolve end:
+ * - Copy auto inherited comments from heritage clauses
+ * - Handle `@inheritDoc`
+ * - Resolve `@link` tags to point to target reflections
  */
 @Component({ name: "comment" })
 export class CommentPlugin extends ConverterComponent {