A documentation generator for Dart.
Classes
- Accessor
- Getters and setters.
- Class
- Config
- Constructor
- DartDoc
- Generates Dart documentation for all public Dart libraries in the given directory.
- DartDocFailure
- This class is returned if dartdoc fails in an expected way (for instance, if there is an analysis error in the library).
- DartDocResults
- The results of a DartDoc.generateDocs call.
- Documentable
- Bridges the gap between model elements and packages, both of which have documentation.
- Dynamic
- ElementType
- EnclosedElement
- An element that is enclosed by some other element.
- Enum
- EnumField
- Enum's fields are virtual, so we do a little work to create usable values for the docs.
- Field
- FileContents
- Generator
- An abstract class that defines a generator that generates documentation for a given package.
- GetterSetterCombo
- Mixin for top-level variables and fields (aka properties)
- Inheritable
- Mixin for subclasses of ModelElement representing Elements that can be inherited from one class to another.
- Library
- Locatable
- Something that can be located for warning purposes.
- Method
- ModelElement
- This class is the foundation of Dartdoc's model for source code. All ModelElements are contained within a Package, and laid out in a structure that mirrors the availability of identifiers in the various namespaces within that package. For example, multiple Class objects for a particular identifier (ModelElement.element) may show up in different Librarys as the identifier is reexported.
- ModelFunction
- Nameable
- Something that has a name.
- Operator
- Package
- PackageCategory
- PackageMeta
- PackageWarningCounter
- PackageWarningOptions
- Parameter
- SourceCodeMixin
- TopLevelVariable
- Top-level variables. But also picks up getters and setters?
- Typedef
- TypeParameter
- Warnable
- Something that package warnings can be called on.
Constants
- featureOrder → Map<String, int>
-
Items mapped less than zero will sort before custom annotations.
Items mapped above zero are sorted after custom annotations.
Items mapped to zero will sort alphabetically among custom annotations.
Custom annotations are assumed to be any annotation or feature not in this
map.
const {'read-only' : 1, 'write-only' : 1, 'read / write' : 1, 'final' : 2, 'inherited' : 3} - name → String
-
'dartdoc' - version → String
-
'0.12.0'
Properties
- config → Config
-
read-only
- defaultOutDir → String
-
final
- packageWarningText ↔ Map<PackageWarning, List<String>>
-
Provides description text and command line flags for warnings.
TODO(jcollins-g): Actually use this for command line flags.
read / write
Functions
-
byFeatureOrdering(
String a, String b) → int -
byName(
Nameable a, Nameable b) → int -
getSdkDir(
) → Directory -
initGenerators(
String url, String relCanonicalPrefix, { List<String> headerFilePaths, String faviconPath, bool useCategories: false, bool prettyIndexJson: false }) → Future<List<Generator>> - Initialize and setup the generators.
-
setConfig(
{Directory inputDir, bool showWarnings: false, bool addCrossdart: false, String examplePathPrefix, bool includeSource: true, String sdkVersion, bool autoIncludeDependencies: false, List<String> categoryOrder }) → void