Documentation class

Documentation provides the information for describing a service.

Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The include directive includes a markdown file from an external source: (== include path/to/file ==) The resource_for directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive suppress_warning does not directly affect documentation and is documented together with service config validation.

Constructors

Documentation({String? documentationRootUrl, String? overview, List<Page>? pages, List<DocumentationRule>? rules, List<Page>? sectionOverrides, String? serviceRootUrl, String? summary})
Documentation.fromJson(Map json_)

Properties

documentationRootUrl ↔ String?
The URL to the root of documentation.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
overview ↔ String?
Declares a single overview page.
getter/setter pair
pages ↔ List<Page>?
The top level pages for the documentation set.
getter/setter pair
rules ↔ List<DocumentationRule>?
A list of documentation rules that apply to individual API elements.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sectionOverrides ↔ List<Page>?
Specifies section and content to override boilerplate content provided by go/api-docgen.
getter/setter pair
serviceRootUrl ↔ String?
Specifies the service root url if the default one (the service name from the yaml file) is not suitable.
getter/setter pair
summary ↔ String?
A short description of what the service does.
getter/setter pair

Methods

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

Operators

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