Function tsDocWrapAsComment

  • Wraps a given string into a TSDoc block comment.

    Parameters

    • string: string

      The string to be wrapped into a TSDoc block comment.

    Returns string

    The input string wrapped into a TSDoc block comment.

    Remarks

    This function is useful when you want to generate TSDoc comments programmatically.

Settings

Member Visibility

Theme

Generated using TypeDoc