1. class
  2. Google
  3. \
  4. Api
  5. \
  6. DocumentationRule

DocumentationRule

class DocumentationRule extends Message

A documentation rule provides information about individual API elements.

Generated from protobuf message google.api.DocumentationRule

Methods

__construct(array $data = NULL)

Constructor.

string
getSelector()

The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.

$this
setSelector(string $var)

The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.

string
getDescription()

Description of the selected API(s).

$this
setDescription(string $var)

Description of the selected API(s).

string
getDeprecationDescription()

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

$this
setDeprecationDescription(string $var)

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

Details

at line 63
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $selector
      The selector is a comma-separated list of patterns. 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". To
      specify a default for all applicable elements, the whole pattern "*"
      is used.
@type string $description
      Description of the selected API(s).
@type string $deprecation_description
      Deprecation description of the selected element(s). It can be provided if an
      element is marked as `deprecated`.

}

at line 79
string getSelector()

The selector is a comma-separated list of patterns. 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". To specify a default for all applicable elements, the whole pattern "" is used.

Generated from protobuf field string selector = 1;

Return Value

string

at line 96
$this setSelector(string $var)

The selector is a comma-separated list of patterns. 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". To specify a default for all applicable elements, the whole pattern "" is used.

Generated from protobuf field string selector = 1;

Parameters

string $var

Return Value

$this

at line 110
string getDescription()

Description of the selected API(s).

Generated from protobuf field string description = 2;

Return Value

string

at line 122
$this setDescription(string $var)

Description of the selected API(s).

Generated from protobuf field string description = 2;

Parameters

string $var

Return Value

$this

at line 137
string getDeprecationDescription()

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

Generated from protobuf field string deprecation_description = 3;

Return Value

string

at line 150
$this setDeprecationDescription(string $var)

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

Generated from protobuf field string deprecation_description = 3;

Parameters

string $var

Return Value

$this