Module ir

Module ir 

Source
Expand description

Intermediate representation for documentation generation

Structs§

DeprecatedInfo
Deprecation information
DocAttribute
A class attribute
DocClass
A class definition
DocDefaultExpression
Default value expression with embedded type references
DocFunction
A function with all its overload signatures
DocModule
A single module’s documentation
DocPackage
Root documentation package structure
DocParameter
A function parameter
DocSignature
A single function signature
DocSubmodule
A reference to a submodule
DocTypeAlias
A type alias definition
DocTypeExpr
Type expression with separate display and link target
DocTypeRef
Type reference within a default value expression
DocVariable
A module-level variable
LinkTarget
Link target information

Enums§

DocDefaultValue
Default value that may contain type references
DocItem
A documented item (function, class, type alias, etc.)
ItemKind
Kind of documented item