Skip to content

Commit

Permalink
Doc comment
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Nov 3, 2022
1 parent 30555f1 commit b0012e5
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions src/lib/converter/plugins/CommentPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit b0012e5

Please sign in to comment.