DocVisitor class
A visitor that traverses the AST to collect documentation components.
This visitor extends RecursiveElementVisitor2 to visit all elements in the
AST recursively. It collects DocComponents for classes, mixins, enums,
type aliases, extensions, and top-level functions.
- Inheritance
-
- Object
- RecursiveElementVisitor2<
void> - DocVisitor
Constructors
- DocVisitor({required String filePath})
Properties
-
components
→ List<
DocComponent> -
final
- filePath → String
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
visitClassElement(
ClassElement2 element) → void -
Visits a class element and extracts its documentation.
override
-
visitConstructorElement(
ConstructorElement2 element) → void -
inherited
-
visitEnumElement(
EnumElement2 element) → void -
Visits an enum element and extracts its documentation.
override
-
visitExtensionElement(
ExtensionElement2 element) → void -
Visits an extension element and extracts its documentation.
override
-
visitExtensionTypeElement(
ExtensionTypeElement2 element) → void -
inherited
-
visitFieldElement(
FieldElement2 element) → void -
inherited
-
visitFieldFormalParameterElement(
FieldFormalParameterElement2 element) → void -
inherited
-
visitFormalParameterElement(
FormalParameterElement element) → void -
inherited
-
visitGenericFunctionTypeElement(
GenericFunctionTypeElement2 element) → void -
inherited
-
visitGetterElement(
GetterElement element) → void -
inherited
-
visitLabelElement(
LabelElement2 element) → void -
inherited
-
visitLibraryElement(
LibraryElement2 element) → void -
inherited
-
visitLocalFunctionElement(
LocalFunctionElement element) → void -
inherited
-
visitLocalVariableElement(
LocalVariableElement2 element) → void -
inherited
-
visitMethodElement(
MethodElement2 element) → void -
inherited
-
visitMixinElement(
MixinElement2 element) → void -
Visits a mixin element and extracts its documentation.
override
-
visitMultiplyDefinedElement(
MultiplyDefinedElement2 element) → void -
inherited
-
visitPrefixElement(
PrefixElement2 element) → void -
inherited
-
visitSetterElement(
SetterElement element) → void -
inherited
-
visitSuperFormalParameterElement(
SuperFormalParameterElement2 element) → void -
inherited
-
visitTopLevelFunctionElement(
TopLevelFunctionElement element) → void -
Visits a top-level function element and extracts its documentation.
override
-
visitTopLevelVariableElement(
TopLevelVariableElement2 element) → void -
inherited
-
visitTypeAliasElement(
TypeAliasElement2 element) → void -
Visits a type alias element and extracts its documentation.
override
-
visitTypeParameterElement(
TypeParameterElement2 element) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited