Type Alias JsDocCompatibility

JsDocCompatibility: {
    defaultTag: boolean;
    exampleTag: boolean;
    ignoreUnescapedBraces: boolean;
    inheritDocTag: boolean;
}

Type declaration

  • defaultTag: boolean

    If set, TypeDoc will treat @default blocks as code unless they contain a code block. On by default, this is how VSCode renders blocks.

  • exampleTag: boolean

    If set, TypeDoc will treat @example blocks as code unless they contain a code block. On by default, this is how VSCode renders blocks.

  • ignoreUnescapedBraces: boolean

    If set, TypeDoc will not emit warnings about unescaped { and } characters encountered when parsing a comment. On by default.

  • inheritDocTag: boolean

    If set, TypeDoc will warn if a @inheritDoc tag is spelled without TSDoc capitalization (i.e. @inheritdoc). On by default.