Packages

c

scala.tools.nsc

ScalaDocReporter

class ScalaDocReporter extends ConsoleReporter

The Scaladoc reporter adds summary messages to the ConsoleReporter

Use the summaryX methods to add unique summarizing message to the end of the run.

Source
ScalaDoc.scala
Linear Supertypes
ConsoleReporter, PrintReporter, FilteringReporter, Reporter, Reporter, AnyRef, Any
Type Hierarchy

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaDocReporter
  2. ConsoleReporter
  3. PrintReporter
  4. FilteringReporter
  5. Reporter
  6. Reporter
  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 ScalaDocReporter(settings: Settings)

Type Members

  1.  final type Severity = reflect.internal.Reporter.Severity
    Definition Classes
    Reporter

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 ScalaDocReporter toany2stringadd[ScalaDocReporter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4.  def ->[B](y: B): (ScalaDocReporter, B)
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toArrowAssoc[ScalaDocReporter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5.  final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6.  final def ERROR: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  7.  final def INFO: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  8.  final def WARNING: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  9.  def addDelayedMessage(pos: Position, msg: String, print: () => Unit): Unit

    Eliminates messages if both pos and msg are equal to existing element

  10.  final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11.  def cancelled: Boolean
    Definition Classes
    Reporter
  12.  def cancelled_=(b: Boolean): Unit
    Definition Classes
    Reporter
  13.  def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14.  def close(): Unit
    Definition Classes
    PrintReporter
  15.  def comment(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  16.  def display(pos: Position, msg: String, severity: Severity): Unit

    Format a message and emit it.

    Format a message and emit it.

    Attributes
    protected
    Definition Classes
    PrintReporter
  17.  def displayPrompt(): Unit
    Definition Classes
    PrintReporter
  18.  def doReport(pos: Position, msg: String, severity: Severity, actions: List[CodeAction]): Unit
    Definition Classes
    ConsoleReporter → Reporter
  19.  final def echo(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  20.  final def echo(msg: String): Unit
    Definition Classes
    Reporter
  21.  val echoWriter: PrintWriter
    Definition Classes
    ConsoleReporter → PrintReporter
  22.  def ensuring(cond: (ScalaDocReporter) => Boolean, msg: => Any): ScalaDocReporter
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toEnsuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23.  def ensuring(cond: (ScalaDocReporter) => Boolean): ScalaDocReporter
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toEnsuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24.  def ensuring(cond: Boolean, msg: => Any): ScalaDocReporter
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toEnsuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25.  def ensuring(cond: Boolean): ScalaDocReporter
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toEnsuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27.  def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  28.  final def error(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  29.  def errorCount: Int
    Definition Classes
    Reporter
  30.  def filter(pos: Position, msg: String, severity: Severity): Int
    Definition Classes
    FilteringReporter → Reporter
  31.  def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  32.  def finish(): Unit
    Definition Classes
    ScalaDocReporter → ConsoleReporter → Reporter
  33.  def flush(): Unit
    Definition Classes
    PrintReporter → Reporter
  34.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35.  def hasErrors: Boolean
    Definition Classes
    ScalaDocReporter → Reporter → Reporter
  36.  def hasWarnings: Boolean
    Definition Classes
    Reporter
  37.  def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38.  def increment(severity: Severity): Unit
    Definition Classes
    Reporter
  39.  def info0(pos: Position, msg: String, severity: Severity, force: Boolean): Unit
    Attributes
    protected
    Definition Classes
    FilteringReporter → Reporter
    Annotations
    @deprecatedOverriding() @nowarn()
  40.  final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42.  final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43.  final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44.  def printDelayedMessages(): Unit
  45.  val reader: BufferedReader
    Definition Classes
    ConsoleReporter → PrintReporter
  46.  def reallyHasErrors: Boolean
  47.  def rerunWithDetails(setting: Setting, name: String): String
    Definition Classes
    Reporter
  48.  def reset(): Unit
    Definition Classes
    FilteringReporter → Reporter → Reporter
  49.  val settings: Settings
    Definition Classes
    ConsoleReporter → PrintReporter → FilteringReporter
  50.  val shortname: Boolean

    Whether a short file name should be displayed before errors

    Whether a short file name should be displayed before errors

    Definition Classes
    PrintReporter
  51.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52.  def toString(): String
    Definition Classes
    AnyRef → Any
  53.  final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55.  final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  56.  final def warning(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  57.  def warningCount: Int
    Definition Classes
    Reporter
  58.  val writer: PrintWriter
    Definition Classes
    ConsoleReporter → PrintReporter

Deprecated Value Members

  1.  def doReport(pos: Position, msg: String, severity: Severity): Unit
    Definition Classes
    FilteringReporter
    Annotations
    @deprecatedOverriding() @deprecated
    Deprecated

    (Since version 2.13.12) use the doReport overload instead

  2.  def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toStringFormat[ScalaDocReporter] 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.

  3.  final def info(pos: Position, msg: String, force: Boolean): Unit
    Definition Classes
    Reporter
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use echo, as internal.Reporter does not support unforced info

  4.  def →[B](y: B): (ScalaDocReporter, B)
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toArrowAssoc[ScalaDocReporter] 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 ConsoleReporter

Inherited from PrintReporter

Inherited from FilteringReporter

Inherited from Reporter

Inherited from Reporter

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromScalaDocReporter to any2stringadd[ScalaDocReporter]

Inherited by implicit conversion StringFormat fromScalaDocReporter to StringFormat[ScalaDocReporter]

Inherited by implicit conversion Ensuring fromScalaDocReporter to Ensuring[ScalaDocReporter]

Inherited by implicit conversion ArrowAssoc fromScalaDocReporter to ArrowAssoc[ScalaDocReporter]

Ungrouped