@eagleoutice/flowr - v2.16.3
    Preparing search index...

    Interface DocumentationMismatchConfig

    interface DocumentationMismatchConfig {
        checkCodoc: boolean;
        checkDefaults: boolean;
        checkInternalUsage: boolean;
        checkUndocumented: boolean;
        checkUsage: boolean;
        requireDocumentation: boolean;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index
    checkCodoc checkDefaults checkInternalUsage checkUndocumented checkUsage requireDocumentation
    checkCodoc: boolean

    report functions whose formals differ from their \usage

    checkDefaults: boolean

    also report default values that differ between the code and its \usage

    checkInternalUsage: boolean

    also check the \usage of pages with the keyword internal

    checkUndocumented: boolean

    report exported objects no Rd page documents

    checkUsage: boolean

    report arguments of a \usage that its \arguments do not document, and documented arguments no \usage has

    requireDocumentation: boolean

    report undocumented objects even when the package has no Rd pages at all

    Settings
    Member Visibility

    On This Page
    Properties