Interface ValidationOptions

Validation options

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

Properties

invalidLink?: boolean

If set, TypeDoc will produce warnings about @link tags which will produce broken links

notDocumented?: boolean

If set, TypeDoc will produce warnings when an exported symbol is not documented

notExported?: boolean

If set, TypeDoc will produce warnings when a symbol is referenced by the documentation