documentation property

ReadonlyArray? get documentation

Static documentation for a class of code actions.

Documentation from the provider is shown in the code actions menu if either:

• Code actions of kind are requested by the editor. In this case, the editor will show the documentation that most closely matches the requested code action kind. For example, if a provider has documentation for both Refactor and RefactorExtract, when the user requests code actions for RefactorExtract, the editor will use the documentation for RefactorExtract instead of the documentation for Refactor.

• Any code actions of kind are returned by the provider.

At most one documentation entry will be shown per provider.

Implementation

_i7.ReadonlyArray<_i2.dynamic>? get documentation => _i5.getProperty(
      this,
      'documentation',
    );