Class: Google::Api::Page

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/documentation.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ ::String

Returns 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.



171
172
173
174
 
# File 'proto_docs/google/api/documentation.rb', line 171

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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].



171
172
173
174
 
# File 'proto_docs/google/api/documentation.rb', line 171

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#subpages ⇒ ::Array<::Google::Api::Page>

Returns 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.



171
172
173
174
 
# File 'proto_docs/google/api/documentation.rb', line 171

class Page
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end