Scala Compiler2.13.0 < 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 ast
  Definition Classes
    nsc
-  package backend
  Definition Classes
    nsc
-  package classpath
  Definition Classes
    nsc
-  package doc
  Definition Classes
    nsc
-  package fsc
  Definition Classes
    nsc
-  package interactive
  Definition Classes
    nsc
-  package interpreter
  Definition Classes
    nsc
-  package io
  Definition Classes
    nsc
-  package javac
  Definition Classes
    nsc
-  package plugins
  Definition Classes
    nsc
-  package profile
  Definition Classes
    nsc
-  package reporters
  Definition Classes
    nsc
-  package settings
  Definition Classes
    nsc
-  package symtab
  Definition Classes
    nsc
-  package transform
  Definition Classes
    nsc
-  package typechecker
  Definition Classes
    nsc
-  package util
  Definition Classes
    nsc
- AbstractScriptRunner
- ClassPathMemoryConsumptionTester
- CloseableRegistry
- CommonRunner
- CompilationUnits
- CompilerCommand
- ConsoleWriter
- DefaultScriptRunner
- Driver
- EvalLoop
- GenericRunnerCommand
- GenericRunnerSettings
- Global
- GlobalSymbolLoaders
- Main
- MainBench
- MainClass
- MainTokenMetric
- NewLinePrintWriter
- ObjectRunner
- Parsing
- PhaseAssembly
- PickleExtractor
- PipelineMain
- PipelineMainClass
- Properties
- Reporting
- ScalaDoc
- ScalaDocReporter
- ScriptRunner
- Settings
- SubComponent

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.  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.  def addDelayedMessage(pos: Position, msg: String, print: () => Unit): Unit

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

7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  var cancelled: Boolean
   Definition Classes
     Reporter
9.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
10.  def close(): Unit
    Definition Classes
      PrintReporter
11.  def comment(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
12.  def count(severity: Severity): Int
    Definition Classes
      Reporter
13.  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
14.  def displayPrompt(): Unit
    Definition Classes
      PrintReporter
15.  def echo(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
16.  def echo(msg: String): Unit
    Definition Classes
      Reporter
17.  val echoWriter: PrintWriter
    Definition Classes
      ConsoleReporter → PrintReporter
18.  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
19.  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
20.  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
21.  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
22.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
24.  def error(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
25.  def errorCount: Int
    Definition Classes
      Reporter
26.  def filter(pos: Position, msg: String, severity: Severity): Boolean
    Attributes
      protected
    Definition Classes
      PositionFiltering → Filtering
27.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
28.  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
29.  def flush(): Unit
    Definition Classes
      PrintReporter → Reporter
30.  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()
31.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
32.  def hasErrors: Boolean
    Definition Classes
      ScalaDocReporter → Reporter → Reporter
33.  def hasWarnings: Boolean
    Definition Classes
      Reporter
34.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
35.  def info0(pos: Position, msg: String, severity: Severity, force: Boolean): Unit
    Attributes
      protected
    Definition Classes
      AbstractReporter → Reporter
36.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
37.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
38.  def noWarnings: Boolean

    True to disable warnings.

    True to disable warnings.

    Attributes
      protected
    Definition Classes
      AbstractReporter → PositionFiltering
39.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
40.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
41.  def printDelayedMessages(): Unit
42.  def printMessage(msg: String): Unit
43.  val reader: BufferedReader
    Definition Classes
      ConsoleReporter → PrintReporter
44.  def reallyHasErrors: Boolean
45.  def rerunWithDetails(setting: Setting, name: String): String
    Definition Classes
      Reporter
46.  def reset(): Unit
    Definition Classes
      PositionFiltering → Reporter
47.  def resetCount(severity: Severity): Unit
    Definition Classes
      Reporter
48.  val settings: Settings
    Definition Classes
      ConsoleReporter → PrintReporter → AbstractReporter
49.  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
50.  def suppressed(pos: Position, msg: String, severity: Severity): Unit

    Invoked when an error or warning is filtered by position.

    Invoked when an error or warning is filtered by position.

    Attributes
      protected
    Definition Classes
      AbstractReporter → PositionFiltering
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.  def warning(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
57.  def warningCount: Int
    Definition Classes
      Reporter
58.  val writer: PrintWriter
    Definition Classes
      ConsoleReporter → PrintReporter
59.  object Direct extends Severity
60.  object ERROR extends Severity
    Definition Classes
      Reporter
61.  object INFO extends Severity
    Definition Classes
      Reporter
62.  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

3.  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 SummaryReporter

### Inherited from PrintReporter

### Inherited from AbstractReporter

### Inherited from PositionFiltering

### Inherited from Filtering

### Inherited from Reporter

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion adapt reporter to legacy API fromScalaDocReporter to Reporter

### 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