DocumentationRule
class DocumentationRule extends Message
A documentation rule provides information about individual API elements.
Generated from protobuf message google.api.DocumentationRule
Methods
No description
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.
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.
Description of the selected API(s).
Description of the selected API(s).
Deprecation description of the selected element(s). It can be provided if an
element is marked as deprecated.
Deprecation description of the selected element(s). It can be provided if an
element is marked as deprecated.
Details
at line 43
__construct()
at line 59
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;
at line 76
$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;
at line 90
string
getDescription()
Description of the selected API(s).
Generated from protobuf field string description = 2;
at line 102
$this
setDescription(string $var)
Description of the selected API(s).
Generated from protobuf field string description = 2;
at line 117
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;
at line 130
$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;