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, String? entryPoint})
Properties
-
components
→ List<
DocComponent> -
final
- entryPoint → String?
-
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(
ClassElement element) → void -
Visits a class element and extracts its documentation.
override
-
visitConstructorElement(
ConstructorElement element) → void -
inherited
-
visitEnumElement(
EnumElement element) → void -
Visits an enum element and extracts its documentation.
override
-
visitExtensionElement(
ExtensionElement element) → void -
Visits an extension element and extracts its documentation.
override
-
visitExtensionTypeElement(
ExtensionTypeElement element) → void -
inherited
-
visitFieldElement(
FieldElement element) → void -
inherited
-
visitFieldFormalParameterElement(
FieldFormalParameterElement element) → void -
inherited
-
visitFormalParameterElement(
FormalParameterElement element) → void -
inherited
-
visitGenericFunctionTypeElement(
GenericFunctionTypeElement element) → void -
inherited
-
visitGetterElement(
GetterElement element) → void -
inherited
-
visitLabelElement(
LabelElement element) → void -
inherited
-
visitLibraryElement(
LibraryElement element) → void -
inherited
-
visitLocalFunctionElement(
LocalFunctionElement element) → void -
inherited
-
visitLocalVariableElement(
LocalVariableElement element) → void -
inherited
-
visitMethodElement(
MethodElement element) → void -
inherited
-
visitMixinElement(
MixinElement element) → void -
Visits a mixin element and extracts its documentation.
override
-
visitMultiplyDefinedElement(
MultiplyDefinedElement element) → void -
inherited
-
visitPrefixElement(
PrefixElement element) → void -
inherited
-
visitSetterElement(
SetterElement element) → void -
inherited
-
visitSuperFormalParameterElement(
SuperFormalParameterElement element) → void -
inherited
-
visitTopLevelFunctionElement(
TopLevelFunctionElement element) → void -
Visits a top-level function element and extracts its documentation.
override
-
visitTopLevelVariableElement(
TopLevelVariableElement element) → void -
inherited
-
visitTypeAliasElement(
TypeAliasElement element) → void -
Visits a type alias element and extracts its documentation.
override
-
visitTypeParameterElement(
TypeParameterElement element) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited