Function getJSDocComment
- getJSDoc
Comment (sourceCode, node, settings): Token | null Parameters
- sourceCode: SourceCode
The ESLint SourceCode
- node: Node
The AST node to get the comment for.
- settings: {
maxLines: number;
minLines: number;
[name: string]: any;
}The settings in context
[name: string]: any
max
Lines : numbermin
Lines : number
Returns Token | null
The Block comment token containing the JSDoc comment for the given node or null if not found.
- sourceCode: SourceCode
Retrieves the JSDoc comment for a given node.