Class DocumentationRule (2.10.0)

public sealed class DocumentationRule : IMessage<DocumentationRule>, IEquatable<DocumentationRule>, IDeepCloneable<DocumentationRule>, IBufferMessage, IMessage

A documentation rule provides information about individual API elements.

Inheritance

object > DocumentationRule

Implements

IMessage DocumentationRule, IEquatable DocumentationRule, IDeepCloneable DocumentationRule, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

DocumentationRule()

public DocumentationRule()

DocumentationRule(DocumentationRule)

public DocumentationRule(DocumentationRule other)

Parameter
Name	Description
`other`	`DocumentationRule`

Fields

DeprecationDescriptionFieldNumber

public const int DeprecationDescriptionFieldNumber = 3

Field number for the "deprecation_description" field.

Field Value
Type	Description
`int`

DescriptionFieldNumber

public const int DescriptionFieldNumber = 2

Field number for the "description" field.

Field Value
Type	Description
`int`

SelectorFieldNumber

public const int SelectorFieldNumber = 1

Field number for the "selector" field.

Field Value
Type	Description
`int`

Properties

DeprecationDescription

public string DeprecationDescription { get; set; }

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

Property Value
Type	Description
`string`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Parser

public static MessageParser<DocumentationRule> Parser { get; }

Property Value
Type	Description
`MessageParserDocumentationRule`

Selector

public string Selector { get; set; }

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b" or "foo..bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

Property Value
Type	Description
`string`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`int`

Clone()

public DocumentationRule Clone()

Returns
Type	Description
`DocumentationRule`

Equals(DocumentationRule)

public bool Equals(DocumentationRule other)

Parameter
Name	Description
`other`	`DocumentationRule`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(DocumentationRule)

public void MergeFrom(DocumentationRule other)

Parameter
Name	Description
`other`	`DocumentationRule`

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`