tinymist_query::docs

Type Alias SignatureDocs

Source 
pub type SignatureDocs = SignatureDocsT<Option<(EcoString, EcoString, EcoString)>>;
Expand description

Documentation about a signature.

Aliased Type§

struct SignatureDocs {
    pub docs: EcoString,
    pub pos: Vec<ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>,
    pub named: BTreeMap<Interned<str>, ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>,
    pub rest: Option<ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>,
    pub ret_ty: Option<(EcoString, EcoString, EcoString)>,
    pub hover_docs: OnceLock<EcoString>,
}

Fields§

§docs: EcoString

Documentation for the function.

§pos: Vec<ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>

The positional parameters.

§named: BTreeMap<Interned<str>, ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>

The named parameters.

§rest: Option<ParamDocsT<Option<(EcoString, EcoString, EcoString)>>>

The rest parameter.

§ret_ty: Option<(EcoString, EcoString, EcoString)>

The return type.

§hover_docs: OnceLock<EcoString>

The full documentation for the signature.