Interface JSDocRenderOptions

interface JSDocRenderOptions {
    link?: "plain" | "code";
    tag?:
        | "bold"
        | "plain"
        | "italic"
        | "bold-italic";
    renderLink?(link: string, display: string): undefined | string;
    renderTag?(tag: JSDocTag): undefined | string;
}

Properties

link? tag?

Methods

renderLink? renderTag?

Properties

Optionallink

link?: "plain" | "code"

Determines the default for rendering @link tags. Defaults to plain.

Optionaltag

tag?:
    | "bold"
    | "plain"
    | "italic"
    | "bold-italic"

Determines the style for rendering tags. Defaults to italic.

Methods

OptionalrenderLink

  • renderLink(link, display): 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

Settings

Member Visibility

On This Page

Properties
Methods