Class

scala.meta.internal.pc.completions.ScaladocCompletions

ScaladocCompletion

Related Doc: package ScaladocCompletions

Permalink

case class ScaladocCompletion(editRange: org.eclipse.lsp4j.Range, associatedDef: MetalsGlobal.MemberDef, pos: MetalsGlobal.Position, text: String) extends MetalsGlobal.CompletionPosition with Product with Serializable

A scaladoc completion showing the parameters of the given associated definition.

editRange

the range in the original source file.

associatedDef

the memberDef associated with the scaladoc to complete. This class will construct scaladoc based on the params of this definition.

pos

the position of the completion request.

text

the text of the original source code.

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, MetalsGlobal.CompletionPosition, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScaladocCompletion
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. CompletionPosition
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScaladocCompletion(editRange: org.eclipse.lsp4j.Range, associatedDef: MetalsGlobal.MemberDef, pos: MetalsGlobal.Position, text: String)

    Permalink

    editRange

    the range in the original source file.

    associatedDef

    the memberDef associated with the scaladoc to complete. This class will construct scaladoc based on the params of this definition.

    pos

    the position of the completion request.

    text

    the text of the original source code.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val associatedDef: MetalsGlobal.MemberDef

    Permalink

    the memberDef associated with the scaladoc to complete.

    the memberDef associated with the scaladoc to complete. This class will construct scaladoc based on the params of this definition.

  6. final lazy val cache: Map[MetalsGlobal.Symbol, Boolean]

    Permalink
    Definition Classes
    CompletionPosition
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def compare(o1: MetalsGlobal.Member, o2: MetalsGlobal.Member): Int

    Permalink

    Returns ordering between two candidate completions.

    Returns ordering between two candidate completions.

    - negative number if o1 member should be sorted before o2 - positive number if o2 member should be sorted before o1 - zero 0 if o1 and o2 are equal

    Definition Classes
    CompletionPosition
  9. def contribute: List[MetalsGlobal.Member]

    Permalink

    Returns candidate completion items.

    Returns candidate completion items.

    Definition Classes
    ScaladocCompletionCompletionPosition
  10. val editRange: org.eclipse.lsp4j.Range

    Permalink

    the range in the original source file.

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def isCandidate(member: MetalsGlobal.Member): Boolean

    Permalink

    Returns false if this member should be excluded from completion items.

    Returns false if this member should be excluded from completion items.

    Definition Classes
    CompletionPosition
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def isNew: Boolean

    Permalink
    Definition Classes
    CompletionPosition
  17. def isPrioritized(m: MetalsGlobal.Member): Boolean

    Permalink

    Returns true if this member should be sorted at the top of completion items.

    Returns true if this member should be sorted at the top of completion items.

    Definition Classes
    CompletionPosition
  18. final def isPrioritizedCached(m: MetalsGlobal.Member): Boolean

    Permalink
    Definition Classes
    CompletionPosition
  19. def isType: Boolean

    Permalink
    Definition Classes
    CompletionPosition
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. val pos: MetalsGlobal.Position

    Permalink

    the position of the completion request.

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. val text: String

    Permalink

    the text of the original source code.

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped