Pike LSP TypeScript API - v0.1.0-alpha.20
    Preparing search index...

    Interface AutodocDocumentation

    Autodoc documentation for a symbol

    interface AutodocDocumentation {
        bugs?: string[];
        deprecated?: string;
        examples?: string[];
        items?: { label: string; text: string }[];
        members?: Record<string, string>;
        notes?: string[];
        params?: Record<string, string>;
        returns?: string;
        seealso?: string[];
        text?: string;
        throws?: string;
    }
    Index

    Properties

    bugs?: string[]

    Bugs

    deprecated?: string

    Deprecation message

    examples?: string[]

    Examples

    items?: { label: string; text: string }[]

    Items (for list/dl documentation)

    members?: Record<string, string>

    Member documentation (for mappings)

    notes?: string[]

    Notes

    params?: Record<string, string>

    Parameter documentation

    returns?: string

    Return value description

    seealso?: string[]

    See also references

    text?: string

    Main description text

    throws?: string

    Throws description