Function parseLeadingComments
- parseLeadingComments(
node: Node | Node,
sourceFile: SourceFile | SourceFile,
options?: Options,
): ParsedLeadingCommentsParameters
- node: Node | Node
Node being processed.
- sourceFile: SourceFile | SourceFile
The TS source file node.
Optionaloptions: OptionsOptions for
comment-parser. The default is to preserve spacing in comment descriptions. Please refer to thecomment-parserdocumentation for options available. Currently,comment-parserdoesn't export theOptions.
Returns ParsedLeadingComments
The parsed leading comments.
- node: Node | Node
Parses all leading JSDoc like block comments for the given Node.