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, SummaryReporter, PrintReporter, AbstractReporter, PositionFiltering, Filtering, Reporter, Reporter, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalaDocReporter
  2. ConsoleReporter
  3. SummaryReporter
  4. PrintReporter
  5. AbstractReporter
  6. PositionFiltering
  7. Filtering
  8. Reporter
  9. Reporter
  10. AnyRef
  11. Any
Implicitly
  1. by adapt reporter to legacy API
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaDocReporter(settings: Settings)

Type Members

  1. class Severity extends AnyRef
    Definition Classes
    Reporter

Value Members

  1. def addDelayedMessage(pos: Position, msg: String, print: () => Unit): Unit

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

  2. var cancelled: Boolean
    Definition Classes
    Reporter
  3. def close(): Unit
    Definition Classes
    PrintReporter
  4. def comment(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  5. def count(severity: Severity): Int
    Definition Classes
    Reporter
  6. def display(pos: Position, msg: String, severity: Severity): Unit

    Format a message and emit it.

    Format a message and emit it.

    Definition Classes
    ConsoleReporter → PrintReporter → AbstractReporter
  7. def displayPrompt(): Unit
    Definition Classes
    PrintReporter
  8. def echo(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  9. def echo(msg: String): Unit
    Definition Classes
    Reporter
  10. val echoWriter: PrintWriter
    Definition Classes
    ConsoleReporter → PrintReporter
  11. def error(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  12. def errorCount: Int
    Definition Classes
    Reporter
  13. def finish(): Unit

    Prints the number of warnings and errors if there are any.

    Prints the number of warnings and errors if there are any.

    Definition Classes
    ScalaDocReporter → SummaryReporter → Reporter
  14. def flush(): Unit
    Definition Classes
    PrintReporter → Reporter
  15. def hasErrors: Boolean
    Definition Classes
    ScalaDocReporter → Reporter → Reporter
  16. def hasWarnings: Boolean
    Definition Classes
    Reporter
  17. def printDelayedMessages(): Unit
  18. def printMessage(msg: String): Unit
  19. val reader: BufferedReader
    Definition Classes
    ConsoleReporter → PrintReporter
  20. def reallyHasErrors: Boolean
  21. def rerunWithDetails(setting: Setting, name: String): String
    Definition Classes
    Reporter
  22. def reset(): Unit
    Definition Classes
    PositionFiltering → Reporter
  23. def resetCount(severity: Severity): Unit
    Definition Classes
    Reporter
  24. val settings: Settings
    Definition Classes
    ConsoleReporter → PrintReporter → AbstractReporter
  25. 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
  26. def warning(pos: Position, msg: String): Unit
    Definition Classes
    Reporter
  27. def warningCount: Int
    Definition Classes
    Reporter
  28. val writer: PrintWriter
    Definition Classes
    ConsoleReporter → PrintReporter
  29. object Direct extends Severity
  30. object ERROR extends Severity
    Definition Classes
    Reporter
  31. object INFO extends Severity
    Definition Classes
    Reporter
  32. object WARNING extends Severity
    Definition Classes
    Reporter

Shadowed Implicit Value Members

  1. var cancelled: Boolean
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).cancelled
    Definition Classes
    Reporter
  2. def comment(pos: Position, msg: String): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).comment(pos, msg)
    Definition Classes
    Reporter
  3. def count: ((severity: _1.Severity)Int) forSome {val _1: Reporter}
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).count
    Definition Classes
    Reporter
  4. def echo(pos: Position, msg: String): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).echo(pos, msg)
    Definition Classes
    Reporter
  5. def echo(msg: String): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).echo(msg)
    Definition Classes
    Reporter
  6. def error(pos: Position, msg: String): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).error(pos, msg)
    Definition Classes
    Reporter
  7. def errorCount: Int
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).errorCount
    Definition Classes
    Reporter
  8. def finish(): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).finish()
    Definition Classes
    Reporter
  9. def flush(): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).flush()
    Definition Classes
    Reporter
  10. def hasErrors: Boolean
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).hasErrors
    Definition Classes
    Reporter → Reporter
  11. def hasWarnings: Boolean
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).hasWarnings
    Definition Classes
    Reporter
  12. def rerunWithDetails(setting: Setting, name: String): String
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).rerunWithDetails(setting, name)
    Definition Classes
    Reporter
  13. def reset(): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).reset()
    Definition Classes
    Reporter → Reporter
  14. def resetCount: ((severity: _1.Severity)Unit) forSome {val _1: Reporter}
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).resetCount
    Definition Classes
    Reporter
  15. def warning(pos: Position, msg: String): Unit
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).warning(pos, msg)
    Definition Classes
    Reporter
  16. def warningCount: Int
    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).warningCount
    Definition Classes
    Reporter

Deprecated Value Members

  1. final def info(pos: Position, msg: String, force: Boolean): Unit

    Informational messages.

    Informational messages. If !force, they may be suppressed.

    Implicit
    This member is added by an implicit conversion from ScalaDocReporter toReporter performed by method adapt reporter to legacy API in scala.tools.nsc.reporters.Reporter.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (scalaDocReporter: Reporter).info(pos, msg, force)
    Definition Classes
    Reporter
    Annotations
    @deprecated
    Deprecated

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

  2. final def info(pos: Position, msg: String, force: Boolean): Unit

    Informational messages.

    Informational messages. If !force, they may be suppressed.

    Definition Classes
    Reporter
    Annotations
    @deprecated
    Deprecated

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