ApiDocGenerator class
Core generator for API reference documentation.
Constructors
- ApiDocGenerator({ApiExtractor? extractor})
Properties
- extractor → ApiExtractor
-
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
-
generateApiDoc(
ApiDocPlan plan) → ApiDocResult - Renders a plan into deterministic Markdown API reference documentation.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
planApiDoc(
ApiDocOptions options) → ApiDocPlan - Plans API documentation from options.
-
planFromTemplate(
Template template) → ApiDocPlan - Plans API documentation by extracting symbols from a Template.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited