Page class final

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

Inheritance

Constructors

Page({String name = '', String content = '', List<Page> subpages = const []})
Page.fromJson(Object? j)
factory

Properties

content String
The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
final
hashCode int
The hash code for this object.
no setterinherited
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:
final
qualifiedName String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subpages List<Page>
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Object
override
toString() String
A string representation of this object.
override

Operators

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

Constants

fullyQualifiedName → const String