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 doc
  Definition Classes
    nsc
-  package base
  Definition Classes
    doc
-  package doclet
  Definition Classes
    doc
-  package html
  Definition Classes
    doc
-  package model
  Definition Classes
    doc
- DocFactory
- DocParser
- Index
- ScaladocAnalyzer
- ScaladocGlobal
- ScaladocGlobalTrait
- ScaladocSyntaxAnalyzer
- Settings
- Uncompilable
- Universe

c

scala.tools.nsc.doc

# Settings

###

#### class Settings extends nsc.Settings

An extended version of compiler settings, with additional Scaladoc-specific options.

Source
  Settings.scala

Linear Supertypes
nsc.Settings, MutableSettings, ScalaSettings, Warnings, StandardScalaSettings, AbsScalaSettings, AbsSettings, MutableSettings, AbsSettings, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Settings
2. Settings
3. MutableSettings
4. ScalaSettings
5. Warnings
6. StandardScalaSettings
7. AbsScalaSettings
8. AbsSettings
9. MutableSettings
10. AbsSettings
11. AnyRef
12. 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 Settings(error: (String) => Unit, printMsg: (String) => Unit = println(_))

   error

     A function that prints a string to the appropriate error stream

   printMsg

     A function that prints the string, without any extra boilerplate of error

### Type Members

1.  trait AbsSettingValue extends AnyRef
   Definition Classes
     AbsSettings
2.  type ResultOfTryToSet = collection.immutable.List[String]
   Definition Classes
     MutableSettings → AbsSettings
3.  trait SettingValue extends reflect.internal.settings.MutableSettings.AbsSettingValue
   Definition Classes
     MutableSettings
4.  trait AbsSetting extends Ordered[Setting] with AbsSettingValue
   Definition Classes
     AbsSettings
5.  trait InternalSetting extends AbsSetting
   Definition Classes
     AbsSettings
6.  class BooleanSetting extends Setting

   A setting represented by a boolean flag (false, unless set)

   A setting represented by a boolean flag (false, unless set)

   Definition Classes
     MutableSettings
7.  class ChoiceSetting extends Setting

   A setting represented by a string in a given set of `choices`, (`default` unless set).

   A setting represented by a string in a given set of `choices`, (`default` unless set).

   Definition Classes
     MutableSettings
8.  class EnableSettings[T <: BooleanSetting] extends AnyRef

   Internal use - syntax enhancements.

   Internal use - syntax enhancements.

   Attributes
     protected
   Definition Classes
     MutableSettings
9.  class IntSetting extends Setting

   A setting represented by an integer.

   A setting represented by an integer.

   Definition Classes
     MutableSettings
10.  abstract class MultiChoiceEnumeration extends Enumeration

    Each MultiChoiceSetting takes a MultiChoiceEnumeration as domain.

    Each MultiChoiceSetting takes a MultiChoiceEnumeration as domain. The enumeration may use the Choice class to define values, or simply use the default `Value` constructor:

    object SettingDomain extends MultiChoiceEnumeration { val arg1, arg2 = Value }

    Or

    object SettingDomain extends MultiChoiceEnumeration { val arg1 = Choice("arg1", "help") val arg2 = Choice("arg2", "help") }

    Choices with a non-empty `expandsTo` enable other options. Note that expanding choices are not present in the multiChoiceSetting.value set, only their expansion.

    Definition Classes
      MutableSettings
11.  class MultiChoiceSetting[E <: MultiChoiceEnumeration] extends Setting with Clearable

    A Setting that collects string-valued settings from an enumerated domain.

    A Setting that collects string-valued settings from an enumerated domain.

    - These choices can be turned on or off: "-option:on,-off"
    - If an option is set both on and off, then the option is on
    - The choice "_" enables all choices that have not been explicitly disabled

    Arguments can be provided in colonated or non-colonated mode, i.e. "-option a b" or "-option:a,b". Note that arguments starting with a "-" can only be provided in colonated mode, otherwise they are interpreted as a new option.

    In non-colonated mode, the setting stops consuming arguments at the first non-choice, i.e. "-option a b c" only consumes "a" and "b" if "c" is not a valid choice.

    Definition Classes
      MutableSettings
12.  class MultiStringSetting extends Setting with Clearable

    A setting that accumulates all strings supplied to it, until it encounters one starting with a '-'.

    A setting that accumulates all strings supplied to it, until it encounters one starting with a '-'.

    Definition Classes
      MutableSettings
13.  class OutputDirs extends AnyRef

    A class for holding mappings from source directories to their output location.

    A class for holding mappings from source directories to their output location. This functionality can be accessed only programmatically. The command line compiler uses a single output location, but tools may use this functionality to set output location per source directory.

    Definition Classes
      MutableSettings
14.  class OutputSetting extends StringSetting

    Set the output directory.

    Set the output directory.

    Definition Classes
      MutableSettings
15.  class PathSetting extends StringSetting
    Definition Classes
      MutableSettings
16.  class PhasesSetting extends Setting with Clearable

    A setting represented by a list of strings which should be prefixes of phase names.

    A setting represented by a list of strings which should be prefixes of phase names. This is not checked here, however. Alternatively, underscore can be used to indicate all phases.

    Definition Classes
      MutableSettings
17.  class PrefixSetting extends Setting

    A special setting for accumulating arguments like -Dfoo=bar.

    A special setting for accumulating arguments like -Dfoo=bar.

    Definition Classes
      MutableSettings
18.  class ScalaVersionSetting extends Setting

    A setting represented by a Scala version.

    A setting represented by a Scala version. The `initial` value is used if the setting is not specified. The `default` value is used if the option is specified without argument (e.g., `-Xmigration`).

    Definition Classes
      MutableSettings
19.  abstract class Setting extends AbsSetting with SettingValue

    A base class for settings of all types.

    A base class for settings of all types. Subclasses each define a `value` field of the appropriate type.

    Definition Classes
      MutableSettings
20.  class StringSetting extends Setting

    A setting represented by a string, (`default` unless set)

    A setting represented by a string, (`default` unless set)

    Definition Classes
      MutableSettings
21.  sealed abstract class CachePolicy extends AnyRef
    Definition Classes
      ScalaSettings

### 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 Settings toany2stringadd[Settings] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Settings, B)
   Implicit
     This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def BooleanSetting(name: String, descr: String): BooleanSetting
   Definition Classes
     MutableSettings → AbsScalaSettings
7.  def ChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: String, choicesHelp: List[String]): ChoiceSetting
   Definition Classes
     MutableSettings → AbsScalaSettings
8.  def ChoiceSettingForcedDefault(name: String, helpArg: String, descr: String, choices: List[String], default: String, choicesHelp: List[String]): ChoiceSetting
   Definition Classes
     MutableSettings → AbsScalaSettings
9.  def IntSetting(name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) => Option[Int]): IntSetting
   Definition Classes
     MutableSettings → AbsScalaSettings
10.  def MultiChoiceSetting[E <: MultiChoiceEnumeration](name: String, helpArg: String, descr: String, domain: E, default: Option[List[String]] = None): MultiChoiceSetting[E]
    Definition Classes
      MutableSettings → AbsScalaSettings
11.  def MultiStringSetting(name: String, arg: String, descr: String, helpText: Option[String]): MultiStringSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
12.  def OutputSetting(outputDirs: OutputDirs, default: String): OutputSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
13.  def PathSetting(name: String, descr: String, default: String): PathSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
14.  def PhasesSetting(name: String, descr: String, default: String = ""): PhasesSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
15.  def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
16.  def ScalaVersionSetting(name: String, arg: String, descr: String, initial: ScalaVersion, default: Option[ScalaVersion] = None): ScalaVersionSetting
    Definition Classes
      MutableSettings
17.  def StringSetting(name: String, arg: String, descr: String, default: String, helpText: Option[String]): StringSetting
    Definition Classes
      MutableSettings → AbsScalaSettings
18.  val Vhelp: BooleanSetting

    -V "Verbose" settings

    -V "Verbose" settings

    Definition Classes
      ScalaSettings
19.  val Whelp: BooleanSetting
    Definition Classes
      Warnings
20.  val Xexperimental: BooleanSetting
    Definition Classes
      ScalaSettings
21.  val Xhelp: BooleanSetting

    -X "Advanced" settings

    -X "Advanced" settings

    Definition Classes
      ScalaSettings
22.  val XlogImplicits: BooleanSetting
    Definition Classes
      ScalaSettings
23.  val XmacroSettings: MultiStringSetting
    Definition Classes
      ScalaSettings
24.  val Xmigration: ScalaVersionSetting
    Definition Classes
      ScalaSettings
25.  val XmixinForceForwarders: ChoiceSetting
    Definition Classes
      ScalaSettings
26.  val XnoPatmatAnalysis: BooleanSetting
    Definition Classes
      ScalaSettings
27.  val Xnojline: BooleanSetting
    Definition Classes
      ScalaSettings
28.  val Xprint: PhasesSetting
    Definition Classes
      ScalaSettings
29.  val Xprintpos: BooleanSetting
    Definition Classes
      ScalaSettings
30.  val Xshowcls: StringSetting
    Definition Classes
      ScalaSettings
31.  val Xshowobj: StringSetting
    Definition Classes
      ScalaSettings
32.  val Xshowtrees: BooleanSetting
    Definition Classes
      ScalaSettings
33.  val XshowtreesCompact: BooleanSetting
    Definition Classes
      ScalaSettings
34.  val XshowtreesStringified: BooleanSetting
    Definition Classes
      ScalaSettings
35.  val Xverify: BooleanSetting
    Definition Classes
      ScalaSettings
36.  val Xxml: MultiChoiceSetting[XxmlSettings.type]
    Definition Classes
      ScalaSettings
37.  val YaddBackendThreads: IntSetting
    Definition Classes
      ScalaSettings
38.  val YcacheMacroClassLoader: ChoiceSetting
    Definition Classes
      ScalaSettings
39.  val YcachePluginClassLoader: ChoiceSetting
    Definition Classes
      ScalaSettings
40.  val Ycompacttrees: BooleanSetting
    Definition Classes
      ScalaSettings
41.  val Ydelambdafy: ChoiceSetting
    Definition Classes
      ScalaSettings
42.  val YdisableFlatCpCaching: BooleanSetting
    Definition Classes
      ScalaSettings
43.  val Ydocdebug: BooleanSetting
    Definition Classes
      ScalaSettings
44.  val Ydumpclasses: StringSetting
    Definition Classes
      ScalaSettings
45.  val Ygenasmp: StringSetting
    Definition Classes
      ScalaSettings
46.  val Yhelp: BooleanSetting

    -Y "Private" settings

    -Y "Private" settings

    Definition Classes
      ScalaSettings
47.  val YhotStatisticsEnabled: BooleanSetting
    Definition Classes
      ScalaSettings
48.  val Yidedebug: BooleanSetting
    Definition Classes
      ScalaSettings
49.  val Yissuedebug: BooleanSetting
    Definition Classes
      ScalaSettings
50.  val YjarCompressionLevel: IntSetting
    Definition Classes
      ScalaSettings
51.  val Ylogcp: BooleanSetting
    Definition Classes
      ScalaSettings
52.  val YmacroAnnotations: BooleanSetting
    Definition Classes
      ScalaSettings
53.  val YmacroClasspath: PathSetting
    Definition Classes
      ScalaSettings
54.  val YmacroFresh: BooleanSetting
    Definition Classes
      ScalaSettings
55.  val YmacrodebugLite: BooleanSetting
    Definition Classes
      ScalaSettings
56.  val YmacrodebugVerbose: BooleanSetting
    Definition Classes
      ScalaSettings
57.  val Ymacroexpand: ChoiceSetting
    Definition Classes
      ScalaSettings
58.  val YmaxQueue: IntSetting
    Definition Classes
      ScalaSettings
59.  val Ymemberpos: StringSetting
    Definition Classes
      ScalaSettings
60.  val Ynogenericsig: BooleanSetting
    Definition Classes
      ScalaSettings
61.  val YoptInlineHeuristics: ChoiceSetting
    Definition Classes
      ScalaSettings
62.  val YoptLogInline: StringSetting
    Definition Classes
      ScalaSettings
63.  val YoptTrace: StringSetting
    Definition Classes
      ScalaSettings
64.  val YpatmatExhaustdepth: IntSetting
    Definition Classes
      ScalaSettings
65.  val Ypatmatdebug: BooleanSetting
    Definition Classes
      ScalaSettings
66.  val YpickleJava: BooleanSetting
    Definition Classes
      ScalaSettings
67.  val Yposdebug: BooleanSetting
    Definition Classes
      ScalaSettings
68.  val YpresentationAnyThread: BooleanSetting
    Definition Classes
      ScalaSettings
69.  val YpresentationDebug: BooleanSetting
    Definition Classes
      ScalaSettings
70.  val YpresentationDelay: IntSetting
    Definition Classes
      ScalaSettings
71.  val YpresentationLog: StringSetting
    Definition Classes
      ScalaSettings
72.  val YpresentationReplay: StringSetting
    Definition Classes
      ScalaSettings
73.  val YpresentationStrict: BooleanSetting
    Definition Classes
      ScalaSettings
74.  val YpresentationVerbose: BooleanSetting

    IDE-specific settings

    IDE-specific settings

    Definition Classes
      ScalaSettings
75.  val YprintTrees: ChoiceSetting
    Definition Classes
      ScalaSettings
76.  val YprofileDestination: StringSetting
    Definition Classes
      ScalaSettings
77.  val YprofileEnabled: BooleanSetting
    Definition Classes
      ScalaSettings
78.  val YprofileExternalTool: PhasesSetting
    Definition Classes
      ScalaSettings
79.  val YprofileRunGcBetweenPhases: PhasesSetting
    Definition Classes
      ScalaSettings
80.  val YprofileTrace: StringSetting
    Definition Classes
      ScalaSettings
81.  val Yquasiquotedebug: BooleanSetting
    Definition Classes
      ScalaSettings
82.  val Yrangepos: BooleanSetting
    Definition Classes
      ScalaSettings
83.  val Yrecursion: IntSetting
    Definition Classes
      ScalaSettings
84.  val Yreifycopypaste: BooleanSetting
    Definition Classes
      ScalaSettings
85.  val Yreifydebug: BooleanSetting
    Definition Classes
      ScalaSettings
86.  val Yreplclassbased: BooleanSetting
    Definition Classes
      ScalaSettings
87.  val Yreploutdir: StringSetting
    Definition Classes
      ScalaSettings
88.  val Yscriptrunner: StringSetting
    Definition Classes
      ScalaSettings
89.  val Yshow: PhasesSetting
    Definition Classes
      ScalaSettings
90.  val Yshowsymkinds: BooleanSetting
    Definition Classes
      ScalaSettings
91.  val Yshowsymowners: BooleanSetting
    Definition Classes
      ScalaSettings
92.  val Yshowsyms: BooleanSetting
    Definition Classes
      ScalaSettings
93.  val Ystatistics: PhasesSetting
    Definition Classes
      ScalaSettings
94.  val YstatisticsEnabled: BooleanSetting
    Definition Classes
      ScalaSettings
95.  val Ytyperdebug: BooleanSetting
    Definition Classes
      ScalaSettings
96.  val Yvalidatepos: PhasesSetting
    Definition Classes
      ScalaSettings
97.  lazy val allSettings: HashSet[Setting]

    Set of settings

    Set of settings

    Attributes
      protected[scala]
    Definition Classes
      ScalaSettings
98.  final def asInstanceOf[T0]: T0
    Definition Classes
      Any
99.  val bootclasspath: PathSetting

    Path related settings.

    Path related settings.

    Definition Classes
      StandardScalaSettings
100.  val breakCycles: BooleanSetting
     Definition Classes
       ScalaSettings
101.  val browse: PhasesSetting
     Definition Classes
       ScalaSettings
102.  val check: PhasesSetting
     Definition Classes
       ScalaSettings
103.  def checkDependencies: Boolean
     Definition Classes
       AbsSettings
104.  val checkInit: BooleanSetting
     Definition Classes
       ScalaSettings
105.  val classpath: PathSetting
     Definition Classes
       ScalaSettings → StandardScalaSettings
106.  def clone(): AnyRef
     Attributes
       protected[java.lang]
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.CloneNotSupportedException]) @native()
107.  def conflictWarning: Option[String]
     Definition Classes
       ScalaSettings
108.  def copy(): nsc.Settings

     Create a new Settings object, copying all user-set values.

     Create a new Settings object, copying all user-set values.

     Definition Classes
       MutableSettings
109.  def copyInto(settings: MutableSettings): Unit
     Definition Classes
       MutableSettings
110.  val d: OutputSetting
     Definition Classes
       ScalaSettings → StandardScalaSettings
111.  val debug: BooleanSetting
     Definition Classes
       ScalaSettings
112.  def debuginfo: ChoiceSetting

     Compatibility stubs for options whose value name did not previously match the option name.

     Compatibility stubs for options whose value name did not previously match the option name.

     Definition Classes
       ScalaSettings
113.  def defaultClasspath: String

     The user class path, specified by `-classpath` or `-cp`, defaults to the value of CLASSPATH env var if it is set, as in Java, or else to `"."` for the current user directory.

     The user class path, specified by `-classpath` or `-cp`, defaults to the value of CLASSPATH env var if it is set, as in Java, or else to `"."` for the current user directory.

     Attributes
       protected
     Definition Classes
       ScalaSettings
114.  val defines: PrefixSetting
     Definition Classes
       ScalaSettings
115.  def dependenciesFile: StringSetting
     Definition Classes
       ScalaSettings
116.  val dependencyfile: StringSetting

     Other settings.

     Other settings.

     Definition Classes
       StandardScalaSettings
117.  val deprecation: BooleanSetting
     Definition Classes
       StandardScalaSettings
118.  val developer: BooleanSetting
     Definition Classes
       ScalaSettings
119.  def disable(s: Setting): HashSet[Setting]

     Disable a setting

     Disable a setting

     Definition Classes
       ScalaSettings
120.  val disable: MultiStringSetting
     Definition Classes
       ScalaSettings
121.  val docAuthor: BooleanSetting
122.  val docCanonicalBaseUrl: StringSetting
123.  val docDiagrams: BooleanSetting
124.  val docDiagramsDebug: BooleanSetting
125.  val docDiagramsDotPath: PathSetting
126.  val docDiagramsDotRestart: IntSetting
127.  val docDiagramsDotTimeout: IntSetting
128.  val docDiagramsMaxImplicitClasses: IntSetting

     The maximum number of implicit classes to show in the diagram

129.  val docDiagramsMaxNormalClasses: IntSetting

     The maximum number of normal classes to show in the diagram

130.  val docExpandAllTypes: BooleanSetting
131.  val docExternalDoc: MultiStringSetting
132.  val docGroups: BooleanSetting
133.  val docImplicits: BooleanSetting
134.  val docImplicitsDebug: BooleanSetting
135.  val docImplicitsHide: MultiStringSetting
136.  val docImplicitsShowAll: BooleanSetting
137.  val docImplicitsSoundShadowing: BooleanSetting
138.  val docNoJavaComments: BooleanSetting
139.  val docNoLinkWarnings: BooleanSetting
140.  val docNoPrefixes: BooleanSetting
141.  val docRawOutput: BooleanSetting
142.  val docRootContent: PathSetting
143.  val docSkipPackages: StringSetting
144.  val docUncompilable: StringSetting
145.  val docfooter: StringSetting
146.  val docformat: ChoiceSetting

     A setting that defines in which format the documentation is output.

     A setting that defines in which format the documentation is output. Note: this setting is currently always `html`.

147.  val docgenerator: StringSetting
148.  val docsourceurl: StringSetting

     A setting that defines a URL to be concatenated with source locations and show a link to source files.

     A setting that defines a URL to be concatenated with source locations and show a link to source files. If needed the sourcepath option can be used to exclude undesired initial part of the link to sources

149.  val doctitle: StringSetting

     A setting that defines the overall title of the documentation, typically the name of the library being documented.

150.  val docversion: StringSetting

     A setting that defines the overall version number of the documentation, typically the version of the library being documented.

151.  val elidebelow: IntSetting
     Definition Classes
       ScalaSettings
152.  def embeddedDefaults(loader: ClassLoader): Unit

     Initializes these settings for embedded use by a class from the given class loader.

     Initializes these settings for embedded use by a class from the given class loader. The class loader for `T` should provide resources `app.class.path` and `boot.class.path`. These resources should contain the application and boot classpaths in the same form as would be passed on the command line.

     Definition Classes
       MutableSettings
153.  def embeddedDefaults[T](implicit arg0: ClassTag[T]): Unit

     Initializes these settings for embedded use by type `T`.

     Initializes these settings for embedded use by type `T`. The class loader defining `T` should provide resources `app.class.path` and `boot.class.path`. These resources should contain the application and boot classpaths in the same form as would be passed on the command line.

     Definition Classes
       MutableSettings
154.  val encoding: StringSetting
     Definition Classes
       StandardScalaSettings
155.  def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
     Implicit
       This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
     Definition Classes
       Ensuring
156.  def ensuring(cond: (Settings) => Boolean): Settings
     Implicit
       This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
     Definition Classes
       Ensuring
157.  def ensuring(cond: Boolean, msg: => Any): Settings
     Implicit
       This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
     Definition Classes
       Ensuring
158.  def ensuring(cond: Boolean): Settings
     Implicit
       This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
     Definition Classes
       Ensuring
159.  final def eq(arg0: AnyRef): Boolean
     Definition Classes
       AnyRef
160.  def equals(that: Any): Boolean
     Definition Classes
       AbsSettings → AnyRef → Any
161.  val errorFn: (String) => Unit
     Definition Classes
       MutableSettings → AbsSettings
162.  val explaintypes: BooleanSetting
     Definition Classes
       StandardScalaSettings
163.  val exposeEmptyPackage: BooleanSetting
     Definition Classes
       ScalaSettings
164.  lazy val extUrlMapping: Map[String, String]
165.  val extdirs: PathSetting
     Definition Classes
       StandardScalaSettings
166.  val fatalWarnings: BooleanSetting
     Definition Classes
       Warnings
167.  val feature: BooleanSetting
     Definition Classes
       StandardScalaSettings
168.  def finalize(): Unit
     Attributes
       protected[java.lang]
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.Throwable])
169.  def formatted(fmtstr: String): String
     Implicit
       This member is added by an implicit conversion from Settings toStringFormat[Settings] performed by method StringFormat in scala.Predef.
     Definition Classes
       StringFormat
     Annotations
       @inline()
170.  val future: BooleanSetting

     Groups of Settings.

     Groups of Settings.

     Definition Classes
       ScalaSettings
171.  val g: ChoiceSetting
     Definition Classes
       StandardScalaSettings
172.  val genPhaseGraph: StringSetting
     Definition Classes
       ScalaSettings
173.  final def getClass(): Class[_ <: AnyRef]
     Definition Classes
       AnyRef → Any
     Annotations
       @native()
174.  def hashCode(): Int
     Definition Classes
       AbsSettings → AnyRef → Any
175.  val help: BooleanSetting
     Definition Classes
       StandardScalaSettings
176.  lazy val hiddenImplicits: Set[String]
177.  val imports: MultiStringSetting
     Definition Classes
       ScalaSettings
178.  def infoSettings: collection.immutable.List[Setting]

     If any of these settings is enabled, the compiler should print a message and exit.

     If any of these settings is enabled, the compiler should print a message and exit.

     Definition Classes
       ScalaSettings
179.  implicit def installEnableSettings[T <: BooleanSetting](s: T): EnableSettings[T]
     Attributes
       protected
     Definition Classes
       MutableSettings
180.  def isInfo: Boolean

     Is an info setting set? Any -option:help?

     Is an info setting set? Any -option:help?

     Definition Classes
       ScalaSettings
181.  final def isInstanceOf[T0]: Boolean
     Definition Classes
       Any
182.  def isScala212: Boolean
     Definition Classes
       ScalaSettings
183.  def isScala213: Boolean
     Definition Classes
       ScalaSettings
184.  def isScala214: Boolean
     Definition Classes
       ScalaSettings
185.  def isScala300: Boolean
     Definition Classes
       ScalaSettings
186.  def isScaladoc: Boolean

     Test whether this is scaladoc we're looking at

     Test whether this is scaladoc we're looking at

     Definition Classes
       Settings → ScalaSettings
187.  val isScaladocSpecific: (String) => Boolean
188.  val javabootclasspath: PathSetting
     Definition Classes
       StandardScalaSettings
189.  val javaextdirs: PathSetting
     Definition Classes
       StandardScalaSettings
190.  val jvmargs: PrefixSetting
     Definition Classes
       ScalaSettings
191.  val language: MultiChoiceSetting[languageFeatures.type]
     Definition Classes
       ScalaSettings
192.  val lint: MultiChoiceSetting[LintWarnings.type]
     Definition Classes
       Warnings
193.  def lintDeprecation: Boolean
     Definition Classes
       Warnings
194.  def lintImplicitNotFound: Boolean
     Definition Classes
       Warnings
195.  def lintUnused: Boolean
     Definition Classes
       Warnings
196.  def lintValPatterns: Boolean
     Definition Classes
       Warnings
197.  val log: PhasesSetting
     Definition Classes
       ScalaSettings
198.  val logFreeTerms: BooleanSetting
     Definition Classes
       ScalaSettings
199.  val logFreeTypes: BooleanSetting
     Definition Classes
       ScalaSettings
200.  val logImplicitConv: BooleanSetting
     Definition Classes
       ScalaSettings
201.  val logReflectiveCalls: BooleanSetting
     Definition Classes
       ScalaSettings
202.  def lookupSetting(cmd: String): Option[Setting]
     Definition Classes
       AbsSettings
203.  val mainClass: StringSetting
     Definition Classes
       ScalaSettings
204.  val maxerrs: IntSetting
     Definition Classes
       ScalaSettings
205.  val maxwarns: IntSetting
     Definition Classes
       ScalaSettings
206.  final def ne(arg0: AnyRef): Boolean
     Definition Classes
       AnyRef
207.  val noCompletion: BooleanSetting
     Definition Classes
       ScalaSettings
208.  val noForwarders: BooleanSetting
     Definition Classes
       ScalaSettings
209.  val noassertions: settings.ScalaSettings.noassertions.stabilizer$1.type.s.type forSome {val stabilizer$1: EnableSettings[BooleanSetting]}
     Definition Classes
       ScalaSettings
210.  val nobootcp: BooleanSetting
     Definition Classes
       ScalaSettings
211.  val noimports: BooleanSetting
     Definition Classes
       ScalaSettings
212.  val nopredef: BooleanSetting
     Definition Classes
       ScalaSettings
213.  val nospecialization: BooleanSetting
     Definition Classes
       ScalaSettings
214.  final def notify(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
215.  final def notifyAll(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
216.  val nouescape: BooleanSetting
     Definition Classes
       ScalaSettings
217.  val nowarn: BooleanSetting
     Definition Classes
       StandardScalaSettings
218.  def nowarnings: BooleanSetting
     Definition Classes
       ScalaSettings
219.  val opt: MultiChoiceSetting[optChoices.type]
     Definition Classes
       ScalaSettings
220.  def optAddToBytecodeRepository: Boolean
     Definition Classes
       ScalaSettings
221.  def optAllowSkipClassLoading: Boolean
     Definition Classes
       ScalaSettings
222.  def optAllowSkipCoreModuleInit: Boolean
     Definition Classes
       ScalaSettings
223.  def optAssumeModulesNonNull: Boolean
     Definition Classes
       ScalaSettings
224.  def optBoxUnbox: Boolean
     Definition Classes
       ScalaSettings
225.  def optBuildCallGraph: Boolean
     Definition Classes
       ScalaSettings
226.  def optClosureInvocations: Boolean
     Definition Classes
       ScalaSettings
227.  def optCompactLocals: Boolean
     Definition Classes
       ScalaSettings
228.  def optCopyPropagation: Boolean
     Definition Classes
       ScalaSettings
229.  val optInlineFrom: MultiStringSetting
     Definition Classes
       ScalaSettings
230.  def optInlinerEnabled: Boolean
     Definition Classes
       ScalaSettings
231.  def optNone: Boolean
     Definition Classes
       ScalaSettings
232.  def optNullnessTracking: Boolean
     Definition Classes
       ScalaSettings
233.  def optRedundantCasts: Boolean
     Definition Classes
       ScalaSettings
234.  def optSimplifyJumps: Boolean
     Definition Classes
       ScalaSettings
235.  def optUnreachableCode: Boolean
     Definition Classes
       ScalaSettings
236.  def optUseAnalyzerCache: Boolean
     Definition Classes
       ScalaSettings
237.  def optWarningEmitAtInlineFailed: Boolean
     Definition Classes
       ScalaSettings
238.  def optWarningNoInlineMissingBytecode: Boolean
     Definition Classes
       ScalaSettings
239.  def optWarningNoInlineMissingScalaInlineInfoAttr: Boolean
     Definition Classes
       ScalaSettings
240.  def optWarningNoInlineMixed: Boolean
     Definition Classes
       ScalaSettings
241.  val optWarnings: MultiChoiceSetting[optWarningsChoices.type]
     Definition Classes
       ScalaSettings
242.  def optWarningsSummaryOnly: Boolean
     Definition Classes
       ScalaSettings
243.  val optimise: BooleanSetting
     Definition Classes
       ScalaSettings → StandardScalaSettings
244.  def outdir: OutputSetting
     Definition Classes
       ScalaSettings
245.  lazy val outputDirs: OutputDirs

     A list pairing source directories with their output directory.

     A list pairing source directories with their output directory. This option is not available on the command line, but can be set by other tools (IDEs especially). The command line specifies a single output directory that is used for all source files, denoted by a '*' in this list.

     Definition Classes
       MutableSettings
246.  def parseParams(args: List[String]): List[String]

     Returns any unprocessed arguments.

     Returns any unprocessed arguments.

     Attributes
       protected
     Definition Classes
       MutableSettings
247.  val plugin: MultiStringSetting
     Definition Classes
       ScalaSettings
248.  val pluginOptions: MultiStringSetting

     -P "Plugin" settings

     -P "Plugin" settings

     Definition Classes
       ScalaSettings
249.  val pluginsDir: StringSetting
     Definition Classes
       ScalaSettings
250.  lazy val prefixSettings: HashSet[PrefixSetting]

     A list of settings which act based on prefix rather than an exact match.

     A list of settings which act based on prefix rather than an exact match. This is basically -D and -J.

     Definition Classes
       MutableSettings
251.  val print: BooleanSetting
     Definition Classes
       StandardScalaSettings
252.  val printArgs: StringSetting
     Definition Classes
       ScalaSettings
253.  def printLate: BooleanSetting
     Definition Classes
       ScalaSettings
254.  val printMsg: (String) => Unit
255.  val printtypes: BooleanSetting
     Definition Classes
       ScalaSettings
256.  def processArgumentString(params: String): (Boolean, List[String])
     Definition Classes
       MutableSettings
257.  def processArguments(arguments: List[String], processAll: Boolean): (Boolean, List[String])

     Iterates over the arguments applying them to settings where applicable.

     Iterates over the arguments applying them to settings where applicable. Then verifies setting dependencies are met.

     This temporarily takes a boolean indicating whether to keep processing if an argument is seen which is not a command line option. This is an expedience for the moment so that you can say

     scalac -d /tmp foo.scala -optimise

     while also allowing

     scala Program opt opt

     to get their arguments.

     Returns (success, List of unprocessed arguments)

     Definition Classes
       MutableSettings
258.  val prompt: BooleanSetting
     Definition Classes
       ScalaSettings
259.  def recreateArgs: collection.immutable.List[String]
     Definition Classes
       AbsSettings
260.  val release: StringSetting
     Definition Classes
       ScalaSettings
261.  def releaseValue: Option[String]
     Definition Classes
       ScalaSettings
262.  val reporter: StringSetting
     Definition Classes
       ScalaSettings
263.  val require: MultiStringSetting
     Definition Classes
       ScalaSettings
264.  val resident: BooleanSetting
     Definition Classes
       ScalaSettings
265.  var scaladocQuietRun: Boolean
266.  def scaladocSpecific: Set[Setting]
267.  val script: StringSetting
     Definition Classes
       ScalaSettings
268.  val showPhases: BooleanSetting
     Definition Classes
       ScalaSettings
269.  val showPlugins: BooleanSetting
     Definition Classes
       ScalaSettings
270.  val skip: PhasesSetting
     Definition Classes
       ScalaSettings
271.  def skipPackage(qname: String): Boolean
272.  lazy val skipPackageNames: Set[String]
273.  val source: ScalaVersionSetting
     Definition Classes
       ScalaSettings
274.  val sourceReader: StringSetting
     Definition Classes
       ScalaSettings
275.  val sourcepath: PathSetting
     Definition Classes
       StandardScalaSettings
276.  def splitParams(line: String): List[String]

     Split the given line into parameters.

     Split the given line into parameters.

     Definition Classes
       MutableSettings
277.  val stopAfter: PhasesSetting
     Definition Classes
       ScalaSettings
278.  val stopBefore: PhasesSetting
     Definition Classes
       ScalaSettings
279.  def stripIndex(url: String): String
280.  final def synchronized[T0](arg0: => T0): T0
     Definition Classes
       AnyRef
281.  val target: ChoiceSetting
     Definition Classes
       StandardScalaSettings
282.  val termConflict: ChoiceSetting
     Definition Classes
       ScalaSettings
283.  def toConciseString: String
     Definition Classes
       AbsSettings
284.  def toString(): String
     Definition Classes
       AbsSettings → AnyRef → Any
285.  val unchecked: BooleanSetting
     Definition Classes
       StandardScalaSettings
286.  lazy val uncompilableFiles: collection.immutable.List[File]
287.  val uniqid: BooleanSetting
     Definition Classes
       StandardScalaSettings
288.  val usejavacp: BooleanSetting
     Definition Classes
       StandardScalaSettings
289.  val usemanifestcp: BooleanSetting
     Definition Classes
       StandardScalaSettings
290.  def userSetSettings: Set[Setting]
     Definition Classes
       AbsSettings
291.  val verbose: BooleanSetting
     Definition Classes
       StandardScalaSettings
292.  val version: BooleanSetting
     Definition Classes
       StandardScalaSettings
293.  def visibleSettings: Set[Setting]
     Definition Classes
       AbsSettings
294.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException])
295.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException])
296.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException]) @native()
297.  def warnAdaptedArgs: Boolean
     Definition Classes
       Warnings
298.  def warnConstant: Boolean
     Definition Classes
       Warnings
299.  val warnDeadCode: BooleanSetting
     Definition Classes
       Warnings
300.  def warnDelayedInit: Boolean
     Definition Classes
       Warnings
301.  def warnDocDetached: Boolean
     Definition Classes
       Warnings
302.  def warnEtaSam: Boolean
     Definition Classes
       Warnings
303.  def warnEtaZero: Boolean
     Definition Classes
       Warnings
304.  val warnExtraImplicit: BooleanSetting
     Definition Classes
       Warnings
305.  def warnInaccessible: Boolean
     Definition Classes
       Warnings
306.  def warnInferAny: Boolean
     Definition Classes
       Warnings
307.  val warnMacros: ChoiceSetting
     Definition Classes
       Warnings
308.  def warnMissingInterpolator: Boolean
     Definition Classes
       Warnings
309.  def warnNonlocalReturn: Boolean
     Definition Classes
       Warnings
310.  def warnNullaryOverride: Boolean
     Definition Classes
       Warnings
311.  def warnNullaryUnit: Boolean
     Definition Classes
       Warnings
312.  val warnNumericWiden: BooleanSetting
     Definition Classes
       Warnings
313.  val warnOctalLiteral: BooleanSetting
     Definition Classes
       Warnings
314.  def warnOptionImplicit: Boolean
     Definition Classes
       Warnings
315.  def warnPackageObjectClasses: Boolean
     Definition Classes
       Warnings
316.  def warnPolyImplicitOverload: Boolean
     Definition Classes
       Warnings
317.  def warnPrivateShadow: Boolean
     Definition Classes
       Warnings
318.  val warnSelfImplicit: BooleanSetting
     Definition Classes
       Warnings
319.  def warnSerialization: Boolean
     Definition Classes
       Warnings
320.  def warnStarsAlign: Boolean
     Definition Classes
       Warnings
321.  def warnTypeParameterShadow: Boolean
     Definition Classes
       Warnings
322.  val warnUnused: MultiChoiceSetting[UnusedWarnings.type]
     Definition Classes
       Warnings
323.  def warnUnusedExplicits: Boolean
     Definition Classes
       Warnings
324.  def warnUnusedImplicits: Boolean
     Definition Classes
       Warnings
325.  def warnUnusedImport: Boolean
     Definition Classes
       Warnings
326.  def warnUnusedLocals: Boolean
     Definition Classes
       Warnings
327.  def warnUnusedParams: Boolean
     Definition Classes
       Warnings
328.  def warnUnusedPatVars: Boolean
     Definition Classes
       Warnings
329.  def warnUnusedPrivates: Boolean
     Definition Classes
       Warnings
330.  val warnValueDiscard: BooleanSetting
     Definition Classes
       Warnings
331.  val warnValueOverrides: BooleanSetting
     Definition Classes
       Warnings
332.  def withErrorFn(errorFn: (String) => Unit): nsc.Settings
     Definition Classes
       Settings → MutableSettings
333.  object hardcoded

     This is the hardcoded area of Scaladoc.

     This is the hardcoded area of Scaladoc. This is where "undesirable" stuff gets eliminated. I know it's not pretty, but ultimately scaladoc has to be useful. :)

334.  object CachePolicy
     Definition Classes
       ScalaSettings
335.  object MacroExpand
     Definition Classes
       ScalaSettings
336.  object XxmlSettings extends MutableSettings.MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
337.  object languageFeatures extends MutableSettings.MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
338.  object mixinForwarderChoices
     Definition Classes
       ScalaSettings
339.  object optChoices extends MutableSettings.MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
340.  object optWarningsChoices extends MutableSettings.MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
341.  object LintWarnings extends MultiChoiceEnumeration
     Definition Classes
       Warnings
342.  object UnusedWarnings extends MultiChoiceEnumeration
     Definition Classes
       Warnings

### Deprecated Value Members

1.  def Xchecknull: BooleanSetting
   Definition Classes
     Warnings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) This option is being removed

2.  def Xwarnfatal: BooleanSetting
   Definition Classes
     Warnings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) Use fatalWarnings

3.  val Yreplsync: BooleanSetting
   Definition Classes
     ScalaSettings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13) Unused setting will be removed

4.  def Ywarndeadcode: BooleanSetting
   Definition Classes
     Warnings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) Use warnDeadCode

5.  def →[B](y: B): (Settings, B)
   Implicit
     This member is added by an implicit conversion from Settings toArrowAssoc[Settings] 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 nsc.Settings

### Inherited from MutableSettings

### Inherited from ScalaSettings

### Inherited from Warnings

### Inherited from StandardScalaSettings

### Inherited from AbsScalaSettings

### Inherited from AbsSettings

### Inherited from MutableSettings

### Inherited from AbsSettings

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromSettings to any2stringadd[Settings]

### Inherited by implicit conversion StringFormat fromSettings to StringFormat[Settings]

### Inherited by implicit conversion Ensuring fromSettings to Ensuring[Settings]

### Inherited by implicit conversion ArrowAssoc fromSettings to ArrowAssoc[Settings]

### Ungrouped