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 ERROR: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  2. final def INFO: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  3. final def WARNING: Severity
    Definition Classes
    Reporter
    Annotations
    @uncheckedStable()
  4. def addDelayedMessage(pos: Position, msg: String, print: () => Unit): Unit

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

  5. def cancelled: Boolean
    Definition Classes
    Reporter
  6. def cancelled_=(b: Boolean): Unit
    Definition Classes
    Reporter
  7. def close(): Unit
    Definition Classes
    PrintReporter
  8. def comment(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  9. def displayPrompt(): Unit
    Definition Classes
    PrintReporter
  10. def doReport(pos: Position, msg: String, severity: Severity, actions: List[CodeAction]): Unit
    Definition Classes
    ConsoleReporter → Reporter
  11. final def echo(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  12. final def echo(msg: String): Unit
    Definition Classes
    Reporter
  13. val echoWriter: PrintWriter
    Definition Classes
    ConsoleReporter → PrintReporter
  14. final def error(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  15. def errorCount: Int
    Definition Classes
    Reporter
  16. def filter(pos: Position, msg: String, severity: Severity): Int
    Definition Classes
    FilteringReporter → Reporter
  17. def finish(): Unit
    Definition Classes
    ScalaDocReporter → ConsoleReporter → Reporter
  18. def flush(): Unit
    Definition Classes
    PrintReporter → Reporter
  19. def hasErrors: Boolean
    Definition Classes
    ScalaDocReporter → Reporter → Reporter
  20. def hasWarnings: Boolean
    Definition Classes
    Reporter
  21. def increment(severity: Severity): Unit
    Definition Classes
    Reporter
  22. def printDelayedMessages(): Unit
  23. val reader: BufferedReader
    Definition Classes
    ConsoleReporter → PrintReporter
  24. def reallyHasErrors: Boolean
  25. def rerunWithDetails(setting: Setting, name: String): String
    Definition Classes
    Reporter
  26. def reset(): Unit
    Definition Classes
    FilteringReporter → Reporter → Reporter
  27. val settings: Settings
    Definition Classes
    ConsoleReporter → PrintReporter → FilteringReporter
  28. 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
  29. final def warning(pos: Position, msg: String, actions: List[CodeAction]): Unit
    Definition Classes
    Reporter
  30. def warningCount: Int
    Definition Classes
    Reporter
  31. 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. 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