Function findJSDocComment
- findJSDoc
Comment (astNode, sourceCode, settings, opts?): Token | null Parameters
- astNode: ESLintOrTSNode
The AST node to get the comment for.
- sourceCode: SourceCode
- settings: {
maxLines: number;
minLines: number;
[name: string]: any;
}[name: string]: any
max
Lines : numbermin
Lines : number
Optional
opts: {
nonJSDoc?: boolean;
}Optional
nonJSDoc?: boolean
Returns Token | null
The Block comment token containing the JSDoc comment for the given node or null if not found.
- astNode: ESLintOrTSNode
Checks for the presence of a JSDoc comment for the given node and returns it.