Type Alias DefDocs

pub type DefDocs = DefDocsT<Option<(EcoString, EcoString, EcoString)>>;

Documentation about a definition.

Aliased Type

enum DefDocs {
    Function(Box<SignatureDocsT<Option<(EcoString, EcoString, EcoString)>>>),
    Variable(VarDocsT<Option<(EcoString, EcoString, EcoString)>>),
    Module(TidyModuleDocs),
    Plain {
        docs: EcoString,
    },
}

Variants

Function(Box<SignatureDocsT<Option<(EcoString, EcoString, EcoString)>>>)

Documentation about a function.

Variable(VarDocsT<Option<(EcoString, EcoString, EcoString)>>)

Documentation about a variable.

Module(TidyModuleDocs)

Documentation about a module.

Plain

Other kinds of documentation.

Fields

docs: EcoString

The content of the documentation.

Implementations

impl DefDocs

pub fn hover_docs(&self) -> EcoString

Get full documentation for the signature.