Documentation constructor

const Documentation({ Input<String>? documentationRootUrl, Input<String>? overview, Input<List<Page>>? pages, Input<List<DocumentationRule>>? rules, Input<List<Page>>? sectionOverrides, Input<String>? serviceRootUrl, Input<String>? summary, })

Creates a new Documentation. documentationRootUrl The URL to the root of documentation. overview Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field. pages The top level pages for the documentation set. rules A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order. sectionOverrides Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries serviceRootUrl Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. summary A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

Implementation

const Documentation({
  this.documentationRootUrl,
  this.overview,
  this.pages,
  this.rules,
  this.sectionOverrides,
  this.serviceRootUrl,
  this.summary,
});