Page class

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Constructors

Page()
Page.fromJson(Map _json)

Properties

content String
The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.
read / write
name String
The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: [...]
read / write
subpages List<Page>
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited