Type Alias ValidationOptions

type ValidationOptions = {
    invalidLink: boolean;
    invalidPath: boolean;
    notDocumented: boolean;
    notExported: boolean;
    rewrittenLink: boolean;
    unusedMergeModuleWith: boolean;
}

Properties

invalidLink: boolean

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

invalidPath: boolean

If set, TypeDoc will produce warnings about relative paths within the documentation which could not be resolved.

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.

rewrittenLink: boolean

If set, TypeDoc will produce warnings about {@link} tags which do not link directly to their target.

unusedMergeModuleWith: boolean

If set, TypeDoc will produce warnings about @mergeModuleWith tags which were not resolved.