Interface JSDocRenderOptions

Optionallink

Optionaltag

OptionalrenderLink

• renderLink(link: string, display: string): undefined | string

  Custom link rendering function. Accepts a link target and a display value for the link. Return a markdown formatted link with the format [$display]($link) or undefined if the link is not a valid target.

  Parameters

  • link: string
  • display: string

  Returns undefined | string

OptionalrenderTag

• renderTag(tag: JSDocTag): undefined | string

  Custom tag rendering function. Return a markdown formatted tag or undefined to fall back to the default rendering.

  Parameters

  • tag: JSDocTag

  Returns undefined | string