PackageMeta class abstract
Describes a single package in the context of dartdoc
.
The primary function of this class is to allow canonicalization of packages by returning the same PackageMeta for a given filename, library or path if they belong to the same package.
Overriding this is typically done by overriding factories as rest of
dartdoc
creates this object by calling these static factories.
- Implementers
Constructors
- PackageMeta(Folder dir, ResourceProvider resourceProvider)
Properties
- description → String
-
no setter
- dir → Folder
-
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- homepage → String
-
no setter
- hostedAt → String?
-
null if not a hosted pub package. If set, the hostname
that the package is hosted at -- usually 'pub.dartlang.org'.
no setter
- isSdk → bool
-
Returns true if this represents a 'Dart' SDK.
no setter
- isValid → bool
-
Returns true if we are a valid package, valid enough to generate docs.
no setter
- name → String
-
no setter
- pathContext → Context
-
no setter
- repository → String
-
no setter
- requiresFlutter → bool
-
no setter
- resolvedDir → String
-
Returns resolved directory.
no setter
- resourceProvider → ResourceProvider
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- version → String
-
no setter
Methods
-
getChangelogContents(
) → File? -
getInvalidReasons(
) → List< String> - Returns a list of reasons this package is invalid, or an empty list if no reasons found.
-
getLicenseContents(
) → File? -
getReadmeContents(
) → File? -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
sdkType(
String? flutterRootPath) → String? - Returns 'Dart' or 'Flutter' (preferentially, 'Flutter' when the answer is "both"), or null if this package is not part of a SDK.
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override