Interface ReferenceDescriptionProvider

createDescriptions

• createDescriptions(
      document: LangiumDocument,
      cancelToken?: Cancellation.CancellationToken,
  ): Promise<ReferenceDescription[]>

  Create descriptions of all cross-references found in the given document. These descriptions are gathered by the IndexManager and stored in the global index so they can be considered when a document change is reported by the client.

  Parameters

  • document: LangiumDocument

    The document in which to gather cross-references.
  • OptionalcancelToken: Cancellation.CancellationToken

    Indicates when to cancel the current operation.

  Returns Promise<ReferenceDescription[]>

  Throws

  OperationCanceled if a user action occurs during execution