Type Members

1.  case class DocumentSymbol(name: String, kind: SymbolKind, range: Range, selectionRange: Range, children: Seq[DocumentSymbol] = Seq(), detail: Option[String] = None, deprecated: Option[Boolean] = None) extends Product with Serializable

   Represents programming constructs like variables, classes, interfaces etc.

   Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.

   name

   The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

   kind

   The kind of this symbol.

   range

   The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

   selectionRange

   The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. Must be contained by the range.

   children

   Children of this symbol, e.g. properties of a class.

   detail

   More detail for this symbol, e.g the signature of a function.

   deprecated

   The kind of this symbol.

2.  case class DocumentSymbolClientCapabilities(dynamicRegistration: Option[Boolean], symbolKind: Option[SymbolKindClientCapabilities], hierarchicalDocumentSymbolSupport: Option[Boolean]) extends Product with Serializable

   Capabilities specific to the textDocument/references

   Capabilities specific to the textDocument/references

   dynamicRegistration

   Whether references supports dynamic registration.

   symbolKind

   Specific capabilities for the SymbolKind.

   hierarchicalDocumentSymbolSupport

   The client supports hierarchical document symbols.

3.  case class DocumentSymbolParams(textDocument: TextDocumentIdentifier) extends Product with Serializable

   The document to provide document links for.

   The document to provide document links for.

   textDocument

   The text document.

4.  case class SymbolInformation(name: String, kind: SymbolKind, location: Location, containerName: Option[String], deprecated: Option[Boolean]) extends Product with Serializable

   Represents information about programming constructs like variables, classes, interfaces etc.

   Represents information about programming constructs like variables, classes, interfaces etc.

   name

   The name of this symbol.

   kind

   The kind of this symbol.

   location

   The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more then the actual symbol's name and does normally include things like visibility modifiers. The range doesn't have to denote a node range in the sense of a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

   containerName

   The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

   deprecated

   Indicates if this symbol is deprecated.

5.  case class SymbolKindClientCapabilities(valueSet: Set[SymbolKind]) extends Product with Serializable

   Specific capabilities for the SymbolKind.

   Specific capabilities for the SymbolKind.

   valueSet

   The symbol kind values the client supports. When this property exists the client also guarantees that it will handle values outside its set gracefully and falls back to a default value when unknown. If this property is not present the client only supports the symbol kinds from File to Array as defined in the initial version of the protocol.