Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DocumentationRule

import type { DocumentationRule } from "https://googleapis.deno.dev/v1/servicemanagement:v1.ts";

A documentation rule provides information about individual API elements.

interface DocumentationRule {
deprecationDescription?: string;
description?: string;
disableReplacementWords?: string;
selector?: string;
}

§Properties

§
deprecationDescription?: string
[src]

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

§
description?: string
[src]

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
[src]

String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.

§
selector?: string
[src]

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.