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
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- ScalaDocReporter
- ConsoleReporter
- PrintReporter
- FilteringReporter
- Reporter
- Reporter
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- final type Severity = reflect.internal.Reporter.Severity
- Definition Classes
- Reporter
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ERROR: Severity
- Definition Classes
- Reporter
- Annotations
- @uncheckedStable()
- final def INFO: Severity
- Definition Classes
- Reporter
- Annotations
- @uncheckedStable()
- final def WARNING: Severity
- Definition Classes
- Reporter
- Annotations
- @uncheckedStable()
- def addDelayedMessage(pos: Position, msg: String, print: () => Unit): Unit
Eliminates messages if both
pos
andmsg
are equal to existing element - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cancelled: Boolean
- Definition Classes
- Reporter
- def cancelled_=(b: Boolean): Unit
- Definition Classes
- Reporter
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def close(): Unit
- Definition Classes
- PrintReporter
- def comment(pos: Position, msg: String): Unit
- Definition Classes
- Reporter
- 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
- def displayPrompt(): Unit
- Definition Classes
- PrintReporter
- def doReport(pos: Position, msg: String, severity: Severity): Unit
- Definition Classes
- ConsoleReporter → FilteringReporter
- final def echo(pos: Position, msg: String): Unit
- Definition Classes
- Reporter
- final def echo(msg: String): Unit
- Definition Classes
- Reporter
- val echoWriter: PrintWriter
- Definition Classes
- ConsoleReporter → PrintReporter
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def error(pos: Position, msg: String): Unit
- Definition Classes
- Reporter
- def errorCount: Int
- Definition Classes
- Reporter
- def filter(pos: Position, msg: String, severity: Severity): Int
- Definition Classes
- FilteringReporter → Reporter
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def finish(): Unit
- Definition Classes
- ScalaDocReporter → ConsoleReporter → Reporter
- def flush(): Unit
- Definition Classes
- PrintReporter → Reporter
- 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
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasErrors: Boolean
- Definition Classes
- ScalaDocReporter → Reporter → Reporter
- def hasWarnings: Boolean
- Definition Classes
- Reporter
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def increment(severity: Severity): Unit
- Definition Classes
- Reporter
- def info0(pos: Position, msg: String, severity: Severity, force: Boolean): Unit
- Attributes
- protected
- Definition Classes
- FilteringReporter → Reporter
- Annotations
- @deprecatedOverriding("override doReport instead", "2.13.1")
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def printDelayedMessages(): Unit
- val reader: BufferedReader
- Definition Classes
- ConsoleReporter → PrintReporter
- def reallyHasErrors: Boolean
- def rerunWithDetails(setting: Setting, name: String): String
- Definition Classes
- Reporter
- def reset(): Unit
- Definition Classes
- FilteringReporter → Reporter → Reporter
- val settings: Settings
- Definition Classes
- ConsoleReporter → PrintReporter → FilteringReporter
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def warning(pos: Position, msg: String): Unit
- Definition Classes
- Reporter
- def warningCount: Int
- Definition Classes
- Reporter
- val writer: PrintWriter
- Definition Classes
- ConsoleReporter → PrintReporter
Deprecated Value Members
- 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
- 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.
The Scala compiler and reflection APIs.