gen_lsp v0.8.1

View Source GenLSP.Structures.RelatedFullDocumentDiagnosticReport (gen_lsp v0.8.1)

A full diagnostic report with a set of related documents.

@since 3.17.0

Link to this section Summary

Types

t()

Functions

%GenLSP.Structures.RelatedFullDocumentDiagnosticReport{}

Fields

  • related_documents: Diagnostics of related documents. This information is useful in programming languages where code in a file A can generate diagnostics in a file B which A depends on. An example of such a language is C/C++ where marco definitions in a file a.cpp and result in errors in a header file b.hpp.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %GenLSP.Structures.RelatedFullDocumentDiagnosticReport{
  items: [GenLSP.Structures.Diagnostic.t()],
  kind: String.t(),
  related_documents:
    %{
      required(GenLSP.BaseTypes.document_uri()) =>
        GenLSP.Structures.FullDocumentDiagnosticReport.t()
        | GenLSP.Structures.UnchangedDocumentDiagnosticReport.t()
    }
    | nil,
  result_id: String.t() | nil
}

Link to this section Functions

Link to this function

%GenLSP.Structures.RelatedFullDocumentDiagnosticReport{}

View Source (struct)

fields

 Fields

  • related_documents: Diagnostics of related documents. This information is useful in programming languages where code in a file A can generate diagnostics in a file B which A depends on. An example of such a language is C/C++ where marco definitions in a file a.cpp and result in errors in a header file b.hpp.

    @since 3.17.0

  • kind: A full document diagnostic report.

  • result_id: An optional result id. If provided it will be sent on the next diagnostic request for the same document.

  • items: The actual items.