Scala Compiler2.13.17 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package interactive
  Definition Classes
    nsc
-  trait CompilerControl extends AnyRef

  Interface of interactive compiler to a client such as an IDE The model the presentation compiler consists of the following parts:

  Interface of interactive compiler to a client such as an IDE The model the presentation compiler consists of the following parts:

  unitOfFile: The map from sourcefiles to loaded units. A sourcefile/unit is loaded if it occurs in that map.

  manipulated by: removeUnitOf, reloadSources.

  A call to reloadSources will add the given sources to the loaded units, and start a new background compiler pass to compile all loaded units (with the indicated sources first). Each background compiler pass has its own typer run. The background compiler thread can be interrupted each time an AST node is completely typechecked in the following ways:

  1. by a new call to reloadSources. This starts a new background compiler pass with a new typer run. 2. by a call to askTypeTree. This starts a new typer run if the forceReload parameter = true 3. by a call to askTypeAt, askTypeCompletion, askScopeCompletion, askToDoFirst, askLinkPos, askLastType. 4. by raising an exception in the scheduler. 5. by passing a high-priority action wrapped in ask { ... }.

  Actions under 1-3 can themselves be interrupted if they involve typechecking AST nodes. High-priority actions under 5 cannot; they always run to completion. So these high-priority actions should to be short.

  Normally, an interrupted action continues after the interrupting action is finished. However, if the interrupting action created a new typer run, the interrupted action is aborted. If there's an outstanding response, it will be set to a Right value with a FreshRunReq exception.

  Definition Classes
    interactive
- AskDocCommentItem
- AskLinkPosItem
- AskLoadedTypedItem
- AskParsedEnteredItem
- AskScopeCompletionItem
- AskToDoFirstItem
- AskTypeAtItem
- AskTypeCompletionItem
- AskTypeItem
- FilesDeletedItem
- Member
- NoWorkScheduler
- ReloadItem
- ScopeMember
- TypeMember
- WorkItem

c

scala.tools.nsc.interactive.CompilerControl

# AskDocCommentItem

###

#### case class AskDocCommentItem(sym: Global.Symbol, source: SourceFile, site: Global.Symbol, fragments: List[(Global.Symbol, SourceFile)], response: Global.Response[(String, String, Global.Position)]) extends Global.WorkItem with Product with Serializable

Source
  CompilerControl.scala

Linear Supertypes
java.io.Serializable, Product, Equals, Global.WorkItem, () => Unit, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. AskDocCommentItem
2. Serializable
3. Product
4. Equals
5. WorkItem
6. Function0
7. AnyRef
8. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new AskDocCommentItem(sym: Global.Symbol, source: SourceFile, site: Global.Symbol, fragments: List[(Global.Symbol, SourceFile)], response: Global.Response[(String, String, Global.Position)])

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Global.AskDocCommentItem toany2stringadd[Global.AskDocCommentItem] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Global.AskDocCommentItem, B)
   Implicit
     This member is added by an implicit conversion from Global.AskDocCommentItem toArrowAssoc[Global.AskDocCommentItem] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def apply(): Unit
   Definition Classes
     AskDocCommentItem → Function0
7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
9.  def ensuring(cond: (Global.AskDocCommentItem) => Boolean, msg: => Any): Global.AskDocCommentItem
   Implicit
     This member is added by an implicit conversion from Global.AskDocCommentItem toEnsuring[Global.AskDocCommentItem] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (Global.AskDocCommentItem) => Boolean): Global.AskDocCommentItem
    Implicit
      This member is added by an implicit conversion from Global.AskDocCommentItem toEnsuring[Global.AskDocCommentItem] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): Global.AskDocCommentItem
    Implicit
      This member is added by an implicit conversion from Global.AskDocCommentItem toEnsuring[Global.AskDocCommentItem] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): Global.AskDocCommentItem
    Implicit
      This member is added by an implicit conversion from Global.AskDocCommentItem toEnsuring[Global.AskDocCommentItem] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  val fragments: List[(Global.Symbol, SourceFile)]
16.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  val onCompilerThread: Boolean
    Definition Classes
      WorkItem
22.  def productElementNames: Iterator[String]
    Definition Classes
      Product
23.  def raiseMissing(): Unit

    Raise a MissingResponse, if the work item carries a response.

    Raise a MissingResponse, if the work item carries a response.

    Definition Classes
      AskDocCommentItem → WorkItem
24.  val response: Global.Response[(String, String, Global.Position)]
25.  val site: Global.Symbol
26.  val source: SourceFile
27.  val sym: Global.Symbol
28.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
29.  def toString(): String
    Definition Classes
      AskDocCommentItem → Function0 → AnyRef → Any
30.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
31.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
32.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Global.AskDocCommentItem toStringFormat[Global.AskDocCommentItem] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (Global.AskDocCommentItem, B)
   Implicit
     This member is added by an implicit conversion from Global.AskDocCommentItem toArrowAssoc[Global.AskDocCommentItem] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from Global.WorkItem

### Inherited from () => Unit

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromGlobal.AskDocCommentItem to any2stringadd[Global.AskDocCommentItem]

### Inherited by implicit conversion StringFormat fromGlobal.AskDocCommentItem to StringFormat[Global.AskDocCommentItem]

### Inherited by implicit conversion Ensuring fromGlobal.AskDocCommentItem to Ensuring[Global.AskDocCommentItem]

### Inherited by implicit conversion ArrowAssoc fromGlobal.AskDocCommentItem to ArrowAssoc[Global.AskDocCommentItem]

### Ungrouped