public sealed class Page : IMessage<Page>, IEquatable<Page>, IDeepCloneable<Page>, IBufferMessage, IMessage
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
Namespace
Google.ApiAssembly
Google.Api.CommonProtos.dll
Constructors
Page()
public Page()
Page(Page)
public Page(Page other)
Fields
ContentFieldNumber
public
const
int
ContentFieldNumber
=
2
Field number for the "content" field.
NameFieldNumber
public
const
int
NameFieldNumber
=
1
Field number for the "name" field.
SubpagesFieldNumber
public
const
int
SubpagesFieldNumber
=
3
Field number for the "subpages" field.
Properties
Content
public string Content { get; set; }
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.
Descriptor
public static MessageDescriptor Descriptor { get; }
Name
public string Name { get; set; }
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
Javapage using Markdown reference link syntax:[Java][Tutorial.Java].
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Parser
public static MessageParser<Page> Parser { get; }
Subpages
public RepeatedField<Page> Subpages { get; }
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
The number of bytes required to write this message to a coded output stream.
Clone()
public Page Clone()
Creates a deep clone of this object.
Equals(Page)
public bool Equals(Page other)
Equals(object)
public override bool Equals(object other)
GetHashCode()
public override int GetHashCode()
MergeFrom(Page)
public void MergeFrom(Page other)
Merges the given message into this one.
See the user guide for precise merge semantics.
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
Merges the data from the specified coded input stream with the current message.
See the user guide for precise merge semantics.
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
output
