root/com.google/com.google.api/com.google.api.documentation/Page

Page

com.google.api.documentation.Page

See thePage companion object

final case class Page(name: String, content: String, subpages: Seq[Page], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Page]

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

Value parameters

content

The Markdown content of the page. You can use <code>(== include {path} ==)</code> to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

name

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: <pre><code>pages:

name: Tutorial content: (== include tutorial.md ==) subpages:
- name: Java content: (== include tutorial_java.md ==) </code></pre> You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].

subpages

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Attributes

Companion: object
Source: Page.scala
Graph
Supertypes: trait Updatable[Page]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all