DocumentEnumAnalyzer class
Ensures enums, their values, and extensions on enums have documentation.
Flags enums, values, and extension members missing documentation comments.
- Inheritance
-
- Object
- BaseAnalyzer
- DocumentEnumAnalyzer
Constructors
Properties
- correctionMessage → String
-
The suggested correction message for fixing a violation of this rule.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- problemMessage → String
-
The main problem message shown when this rule is violated.
no setteroverride
- ruleName → String
-
The unique name of the lint rule implemented by this analyzer.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- severity → String
-
The severity of the lint rule (e.g., 'ERROR', 'WARNING').
no setterinherited
Methods
-
analyze(
CompilationUnit unit) → List< LintIssue> -
Analyze the given
CompilationUnitand return a list of LintIssues.override -
analyzeWithResolver(
CompilationUnit unit, dynamic resolver) → List< LintIssue> -
Analyze the given
CompilationUnitwith resolver context and return a list of LintIssues.inherited -
createIssue(
AstNode node, {String? customMessage}) → LintIssue -
Helper to create a LintIssue from an
AstNodewith consistent formatting.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
shouldSkipFile(
String path) → bool -
Returns true if the file at
pathshould be skipped by this analyzer.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited