Scala Compiler2.12.21 < 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 interactive
  Definition Classes
    nsc
-  package interpreter

  The main REPL related classes and values are as follows.

  The main REPL related classes and values are as follows. In addition to standard compiler classes Global and Settings, there are:

  History: an interface for session history. Completion: an interface for tab completion. ILoop (formerly InterpreterLoop): The umbrella class for a session. IMain (formerly Interpreter): Handles the evolving state of the session and handles submitting code to the compiler and handling the output. InteractiveReader: how ILoop obtains input. History: an interface for session history. Completion: an interface for tab completion. Power: a repository for more advanced/experimental features.

  ILoop contains { in: InteractiveReader, intp: IMain, settings: Settings, power: Power } InteractiveReader contains { history: History, completion: Completion } IMain contains { global: Global }

  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
- ClassPathMemoryConsumptionTester
- CloseableRegistry
- CommonRunner
- CompilationUnits
- CompileClient
- CompileServer
- CompileSocket
- CompilerCommand
- ConsoleWriter
- Driver
- EvalLoop
- GenericRunnerCommand
- GenericRunnerSettings
- Global
- GlobalSymbolLoaders
- HasCompileSocket
- Interpreter
- InterpreterLoop
- JarRunner
- Main
- MainBench
- MainClass
- MainGenericRunner
- MainTokenMetric
- NewLinePrintWriter
- ObjectRunner
- OfflineCompilerCommand
- Parsing
- PhaseAssembly
- PickleExtractor
- PipelineMain
- PipelineMainClass
- Properties
- Reporting
- ScalaDoc
- ScalaDocReporter
- ScriptRunner
- Settings
- StandardCompileClient
- StandardCompileServer
- 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, PrintReporter, FilteringReporter, Reporter, Reporter, AnyRef, Any
 
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. All

### 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 to any2stringadd[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 to ArrowAssoc[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 clabel(severity: Severity): String
    Attributes
      protected
    Definition Classes
      PrintReporter
14.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
15.  def close(): Unit
    Definition Classes
      PrintReporter
16.  def comment(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
17.  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
18.  def displayPrompt(): Unit
    Definition Classes
      PrintReporter
19.  def doReport(pos: Position, msg: String, severity: Severity): Unit
    Definition Classes
      ConsoleReporter → FilteringReporter
20.  final def echo(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
21.  final def echo(msg: String): Unit
    Definition Classes
      Reporter
22.  val echoWriter: PrintWriter
    Definition Classes
      ConsoleReporter → PrintReporter
23.  def ensuring(cond: (ScalaDocReporter) ⇒ Boolean, msg: ⇒ Any): ScalaDocReporter
    Implicit
      This member is added by an implicit conversion from ScalaDocReporter to Ensuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
24.  def ensuring(cond: (ScalaDocReporter) ⇒ Boolean): ScalaDocReporter
    Implicit
      This member is added by an implicit conversion from ScalaDocReporter to Ensuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
25.  def ensuring(cond: Boolean, msg: ⇒ Any): ScalaDocReporter
    Implicit
      This member is added by an implicit conversion from ScalaDocReporter to Ensuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
26.  def ensuring(cond: Boolean): ScalaDocReporter
    Implicit
      This member is added by an implicit conversion from ScalaDocReporter to Ensuring[ScalaDocReporter] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
27.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
28.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
29.  def error(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
30.  def errorCount: Int
    Definition Classes
      Reporter
31.  def filter(pos: Position, msg: String, severity: Severity): Int
    Definition Classes
      FilteringReporter → Reporter
32.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
33.  def finish(): Unit
    Definition Classes
      ScalaDocReporter → ConsoleReporter → Reporter
34.  def flush(): Unit
    Definition Classes
      PrintReporter → Reporter
35.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
36.  def hasErrors: Boolean
    Definition Classes
      ScalaDocReporter → Reporter → Reporter
37.  def hasWarnings: Boolean
    Definition Classes
      Reporter
38.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
39.  def increment(severity: Severity): Unit
    Definition Classes
      Reporter
40.  def info0(pos: Position, msg: String, severity: Severity, force: Boolean): Unit
    Attributes
      protected
    Definition Classes
      FilteringReporter → Reporter
    Annotations
      @deprecatedOverriding( "override doReport instead" , "2.12.13" )
41.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
42.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
43.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
44.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
45.  def printDelayedMessages(): Unit
46.  def printMessage(msg: String): Unit

    Prints the warning or error message.

    Prints the warning or error message.

    Definition Classes
      ScalaDocReporter → PrintReporter
47.  val reader: BufferedReader
    Definition Classes
      ConsoleReporter → PrintReporter
48.  def reallyHasErrors: Boolean
49.  def rerunWithDetails(setting: Setting, name: String): String
    Definition Classes
      Reporter
50.  def reset(): Unit
    Definition Classes
      FilteringReporter → Reporter → Reporter
51.  val settings: Settings
    Definition Classes
      ConsoleReporter → PrintReporter → FilteringReporter
52.  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
53.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
54.  def toString(): String
    Definition Classes
      AnyRef → Any
55.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
56.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
57.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
58.  def warning(pos: Position, msg: String): Unit
    Definition Classes
      Reporter
59.  def warningCount: Int
    Definition Classes
      Reporter
60.  val writer: PrintWriter
    Definition Classes
      ConsoleReporter → PrintReporter
61.  def →[B](y: B): (ScalaDocReporter, B)
    Implicit
      This member is added by an implicit conversion from ScalaDocReporter to ArrowAssoc[ScalaDocReporter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Deprecated Value Members

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

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

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

### Inherited from ConsoleReporter

### Inherited from PrintReporter

### Inherited from FilteringReporter

### Inherited from Reporter

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from ScalaDocReporter to any2stringadd[ScalaDocReporter]

### Inherited by implicit conversion StringFormat from ScalaDocReporter to StringFormat[ScalaDocReporter]

### Inherited by implicit conversion Ensuring from ScalaDocReporter to Ensuring[ScalaDocReporter]

### Inherited by implicit conversion ArrowAssoc from ScalaDocReporter to ArrowAssoc[ScalaDocReporter]

### Ungrouped