Interface DocObject

A documentation object with an optional tree of members.

interface DocObject {
    docstring: string;
    kind: DocKind;
    members?: Record<string, DocObject>;
    name: string;
    path: string;
    signature: string;
}

Properties

docstring kind members? name path signature

Properties

docstring

docstring: string

kind

kind: DocKind

Optionalmembers

members?: Record<string, DocObject>

name

name: string

path

path: string

signature

signature: string

Settings

Member Visibility

On This Page

Properties