parseComment.d.ts 1.3 KB

12345678910111213141516171819202122232425262728293031323334
  1. export function hasSeeWithLink(spec: import('comment-parser').Spec): boolean;
  2. export const defaultNoTypes: string[];
  3. export const defaultNoNames: string[];
  4. /**
  5. * Can't import `comment-parser/es6/parser/tokenizers/index.js`,
  6. * so we redefine here.
  7. */
  8. export type CommentParserTokenizer = (spec: import('comment-parser').Spec) => import('comment-parser').Spec;
  9. /**
  10. * Can't import `comment-parser/es6/parser/tokenizers/index.js`,
  11. * so we redefine here.
  12. * @typedef {(spec: import('comment-parser').Spec) =>
  13. * import('comment-parser').Spec} CommentParserTokenizer
  14. */
  15. /**
  16. * @param {object} [cfg]
  17. * @param {string[]} [cfg.noTypes]
  18. * @param {string[]} [cfg.noNames]
  19. * @returns {CommentParserTokenizer[]}
  20. */
  21. export function getTokenizers({ noTypes, noNames }?: {
  22. noTypes?: string[] | undefined;
  23. noNames?: string[] | undefined;
  24. } | undefined): CommentParserTokenizer[];
  25. /**
  26. * Accepts a comment token and converts it into `comment-parser` AST.
  27. * @param {{value: string}} commentNode
  28. * @param {string} [indent] Whitespace
  29. * @returns {import('./index.js').JsdocBlockWithInline}
  30. */
  31. export function parseComment(commentNode: {
  32. value: string;
  33. }, indent?: string | undefined): import('./index.js').JsdocBlockWithInline;
  34. //# sourceMappingURL=parseComment.d.ts.map