DocumentationRule class

A documentation rule provides information about individual API elements.

Constructors

DocumentationRule()
DocumentationRule.fromJson(Map _json)

Properties

deprecationDescription ↔ String
Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.
read / write
description ↔ String
Description of the selected API(s).
read / write
selector ↔ String
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". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "" is used.
read / write
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() → Map<String, Object>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

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