Skip to main content

Interface: $Properties

options.ExternalDocumentation.$Properties

Properties of an ExternalDocumentation.

Hierarchy​

Properties​

description​

• Optional description: null | string

A short description of the target documentation. GFM syntax can be used for rich text representation.

url​

• Optional url: null | string

The URL for the target documentation. Value MUST be in the format of a URL.