DocumentationRuleResponse class

A documentation rule provides information about individual API elements.

Constructors

DocumentationRuleResponse({required Input<String> deprecationDescription, required Input<String> description, required Input<String> disableReplacementWords, required Input<String> selector})
Creates a new DocumentationRuleResponse. deprecationDescription Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated. description 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. disableReplacementWords String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. selector 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.
const
DocumentationRuleResponse.fromMap(Map<String, dynamic> map)
factory

Properties

deprecationDescription → Input<String>
Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
final
description → Input<String>
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.
final
disableReplacementWords → Input<String>
String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selector → Input<String>
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited