Page
class Page extends Message
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
Generated from protobuf message google.api.Page
Methods
No description
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].
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].
The Markdown content of the page. You can use (== include {path} ==)
to include content from a Markdown file.
The Markdown content of the page. You can use (== include {path} ==)
to include content from a Markdown file.
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Details
at line 53
__construct()
at line 77
string
getName()
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].
Generated from protobuf field string name = 1;
at line 102
$this
setName(string $var)
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].
Generated from protobuf field string name = 1;
at line 117
string
getContent()
The Markdown content of the page. You can use (== include {path} ==)
to include content from a Markdown file.
Generated from protobuf field string content = 2;
at line 130
$this
setContent(string $var)
The Markdown content of the page. You can use (== include {path} ==)
to include content from a Markdown file.
Generated from protobuf field string content = 2;
at line 145
RepeatedField
getSubpages()
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Generated from protobuf field repeated .google.api.Page subpages = 3;
at line 158
$this
setSubpages(Page[]|RepeatedField $var)
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Generated from protobuf field repeated .google.api.Page subpages = 3;