Module docs

Source
Expand description

The documentation analyzers.

Re-exports§

pub use tidy::*;

Modules§

tidy
The documentation models for tidy.

Structs§

DocString
The documentation string of an item
ParamDocsT
Describes a function parameter.
SignatureDocsT
Describes a primary function signature.
VarDoc
The documentation string of a variable associated with some item.
VarDocsT
Describes a primary pattern binding.

Enums§

DefDocsT
Documentation about a definition.

Functions§

format_ty
Formats the type.

Type Aliases§

DefDocs
Documentation about a definition.
ParamDocs
Documentation about a parameter.
SignatureDocs
Documentation about a signature.
TypelessParamDocs
Documentation about a parameter (without type information).
UntypedDefDocs
Documentation about a definition (without type information).
UntypedSignatureDocs
Documentation about a signature.
UntypedVarDocs
Documentation about a variable (without type information).
VarDocs
Documentation about a variable.