DVDocsDocument class

The document: one application's documentation, as data.

Constructors

DVDocsDocument({required String application, required int graphVersion, required List<(String, String)> navigation, required List<DVDocsPage> pages, required List<DVDocsFinding> findings})
const
DVDocsDocument.fromJson(Map<String, Object?> json)
factory

Properties

application → String
The package the site documents, from pubspec.yaml.
final
findings → List<DVDocsFinding>
Sorted by code, then source.
final
graphVersion → int
The graph's own version, shown so a reader can tell which build they are looking at.
final
hashCode → int
The hash code for this object.
no setterinherited
The pages, in navigation order, as (id, label).
final
pages → List<DVDocsPage>
Every page, including the decision records the navigation does not list.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

at(String anchor) → ({DVDocsBlock block, DVDocsPage page})?
The page that holds anchor, and the page it is in, for a link the site resolved while it rendered.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
page(String id) → DVDocsPage?
The page with id, or null. A link that names a page this returns null for is a link to nowhere.
toJson() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited