Type Alias ParamDocs

pub type ParamDocs = ParamDocsT<Option<(EcoString, EcoString, EcoString)>>;

Documentation about a parameter.

Aliased Type

struct ParamDocs {
    pub name: Interned<str>,
    pub docs: EcoString,
    pub cano_type: Option<(EcoString, EcoString, EcoString)>,
    pub default: Option<EcoString>,
    pub attrs: ParamAttrs,
}

Fields

name: Interned<str>

The parameter’s name.

docs: EcoString

Documentation for the parameter.

cano_type: Option<(EcoString, EcoString, EcoString)>

Inferred type of the parameter.

default: Option<EcoString>

The parameter’s default name as value.

attrs: ParamAttrs

The attribute of the parameter.

Implementations

impl ParamDocs

pub fn new(param: &ParamTy, ty: Option<&Ty>) -> Self

Create a new parameter documentation.