Service Usage V1 API - Class Google::Api::Page (v0.6.2)

Reference documentation and code samples for the Service Usage V1 API class Google::Api::Page.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#content

def content() -> ::String
Returns
  • (::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.

#content=

def content=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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:

    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][Tutorial.Java].

#name=

def name=(value) -> ::String
Parameter
  • value (::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:

    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][Tutorial.Java].

Returns
  • (::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:

    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][Tutorial.Java].

#subpages

def subpages() -> ::Array<::Google::Api::Page>
Returns
  • (::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be honored in the generated docset.

#subpages=

def subpages=(value) -> ::Array<::Google::Api::Page>
Parameter
  • value (::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Returns
  • (::Array<::Google::Api::Page>) — Subpages of this page. The order of subpages specified here will be honored in the generated docset.