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. 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.
- Alphabetic
- By Inheritance
- DocumentSymbol
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
DocumentSymbol(name: String, kind: SymbolKind, range: Range, selectionRange: Range, children: Seq[DocumentSymbol] = Seq(), detail: Option[String] = None, deprecated: Option[Boolean] = None)
- 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.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val children: Seq[DocumentSymbol]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @IntrinsicCandidate()
- val deprecated: Option[Boolean]
- val detail: Option[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val kind: SymbolKind
- val name: String
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val range: Range
- val selectionRange: Range
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated