Type Alias UntypedDefDocs

pub type UntypedDefDocs = DefDocsT<()>;

Documentation about a definition (without type information).

Aliased Type

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

Variants

Function(Box<SignatureDocsT<()>>)

Documentation about a function.

Variable(VarDocsT<()>)

Documentation about a variable.

Module(TidyModuleDocs)

Documentation about a module.

Plain

Other kinds of documentation.

Fields

docs: EcoString

The content of the documentation.