Type alias ValidationOptions

ValidationOptions: { invalidLink: boolean; notDocumented: boolean; notExported: boolean }

Type declaration

  • invalidLink: boolean

    If set, TypeDoc will produce warnings about {&link} tags which will produce broken links.

  • notDocumented: boolean

    If set, TypeDoc will produce warnings about declarations that do not have doc comments

  • notExported: boolean

    If set, TypeDoc will produce warnings when a symbol is referenced by the documentation, but is not included in the documentation.

Settings

Member Visibility

Theme

Generated using TypeDoc