GoogleApi.ServiceUsage.V1.Model.Page (google_api_service_usage v0.17.1) View Source

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

Attributes

  • content (type: String.t, default: nil) - The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file.
  • name (type: String.t, default: nil) - 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: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference Java page using Markdown reference link syntax: Java.
  • subpages (type: list(GoogleApi.ServiceUsage.V1.Model.Page.t), default: nil) - Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.ServiceUsage.V1.Model.Page{
  content: String.t() | nil,
  name: String.t() | nil,
  subpages: [GoogleApi.ServiceUsage.V1.Model.Page.t()] | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.