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

    Interface RoxygenArgsResult

    A linting result for a single linting rule match.

    interface RoxygenArgsResult {
        certainty: LintingResultCertainty;
        involvedId: NodeId | NodeId[] | undefined;
        loc: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ];
        overDocumented?: string[];
        quickFix?: LintQuickFix[];
        underDocumented?: string[];
    }

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of RoxygenArgsResult
    Index

    Properties

    certainty involvedId loc overDocumented? quickFix? underDocumented?

    Properties

    certainty: LintingResultCertainty

    The certainty of the linting result.

    involvedId: NodeId | NodeId[] | undefined

    The node ID or IDs involved in this linting result, if applicable.

    loc: [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]
    overDocumented?: string[]
    quickFix?: LintQuickFix[]

    If available, what to do to fix the linting result.

    underDocumented?: string[]

    Settings

    Member Visibility

    On This Page

    Properties