Scala Compiler2.13.7 < 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, 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. AbsSettings
8. MutableSettings
9. AbsSettings
10. AnyRef
11. Any

Implicitly

1. by SettingsOps
2. by any2stringadd
3. by StringFormat
4. by Ensuring
5. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new Settings(error: (String) => Unit, printMsg: (String) => Unit)
2.  new Settings(error: (String) => Unit, printMsg: (String) => Unit = println(_), pathFactory: PathFactory = DefaultPathFactory)

   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 that is a boolean flag, with default as specified.

   A setting that is a boolean flag, with default as specified.

   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 for all sources.

    Set the output directory for all sources.

    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, default: Boolean = false): BooleanSetting
   Definition Classes
     MutableSettings
7.  def ChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: String, choicesHelp: List[String] = Nil): ChoiceSetting
   Definition Classes
     MutableSettings
8.  def IntSetting(name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) => Option[Int]): IntSetting
   Definition Classes
     MutableSettings
9.  def MultiChoiceSetting[E <: MultiChoiceEnumeration](name: String, helpArg: String, descr: String, domain: E, default: Option[List[String]] = None): MultiChoiceSetting[E]
   Definition Classes
     MutableSettings
10.  def MultiStringSetting(name: String, arg: String, descr: String, default: List[String] = Nil, helpText: Option[String] = None, prepend: Boolean = false): MultiStringSetting
    Definition Classes
      MutableSettings
11.  def OutputSetting(default: String): OutputSetting
    Definition Classes
      MutableSettings
12.  def PathSetting(name: String, descr: String, default: String): PathSetting
    Definition Classes
      MutableSettings
13.  def PhasesSetting(name: String, descr: String, default: String = ""): PhasesSetting
    Definition Classes
      MutableSettings
14.  def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
    Definition Classes
      MutableSettings
15.  def ScalaVersionSetting(name: String, arg: String, descr: String, initial: ScalaVersion, default: Option[ScalaVersion] = None): ScalaVersionSetting
    Definition Classes
      MutableSettings
16.  def StringSetting(name: String, arg: String, descr: String, default: String, helpText: Option[String] = None): StringSetting
    Definition Classes
      MutableSettings
17.  val Vhelp: BooleanSetting

    -V "Verbose" settings

    -V "Verbose" settings

    Definition Classes
      ScalaSettings
18.  val Vimplicits: BooleanSetting
    Definition Classes
      ScalaSettings
19.  val VimplicitsMaxRefined: IntSetting
    Definition Classes
      ScalaSettings
20.  val VimplicitsVerboseTree: BooleanSetting
    Definition Classes
      ScalaSettings
21.  val VtypeDiffs: BooleanSetting
    Definition Classes
      ScalaSettings
22.  val Wconf: MultiStringSetting
    Definition Classes
      Warnings
23.  val Whelp: BooleanSetting
    Definition Classes
      Warnings
24.  val Xexperimental: BooleanSetting
    Definition Classes
      ScalaSettings
25.  val Xhelp: BooleanSetting

    -X "Advanced" settings

    -X "Advanced" settings

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

    -Y "Private" settings

    -Y "Private" settings

    Definition Classes
      ScalaSettings
53.  val YhotStatisticsEnabled: BooleanSetting
    Definition Classes
      ScalaSettings
54.  val Yidedebug: BooleanSetting
    Definition Classes
      ScalaSettings
55.  val Yissuedebug: BooleanSetting
    Definition Classes
      ScalaSettings
56.  val YjarCompressionLevel: IntSetting
    Definition Classes
      ScalaSettings
57.  val YjarFactory: StringSetting
    Definition Classes
      ScalaSettings
58.  val Ylogcp: BooleanSetting
    Definition Classes
      ScalaSettings
59.  val YmacroAnnotations: BooleanSetting
    Definition Classes
      ScalaSettings
60.  val YmacroClasspath: PathSetting
    Definition Classes
      ScalaSettings
61.  val YmacroFresh: BooleanSetting
    Definition Classes
      ScalaSettings
62.  val YmacrodebugLite: BooleanSetting
    Definition Classes
      ScalaSettings
63.  val YmacrodebugVerbose: BooleanSetting
    Definition Classes
      ScalaSettings
64.  val Ymacroexpand: ChoiceSetting
    Definition Classes
      ScalaSettings
65.  val YmaxQueue: IntSetting
    Definition Classes
      ScalaSettings
66.  val Ymemberpos: StringSetting
    Definition Classes
      ScalaSettings
67.  val Ynogenericsig: BooleanSetting
    Definition Classes
      ScalaSettings
68.  val YoptInlineHeuristics: ChoiceSetting
    Definition Classes
      ScalaSettings
69.  val YoptLogInline: StringSetting
    Definition Classes
      ScalaSettings
70.  val YoptTrace: StringSetting
    Definition Classes
      ScalaSettings
71.  val Youtline: BooleanSetting
    Definition Classes
      ScalaSettings
72.  val YpatmatExhaustdepth: IntSetting
    Definition Classes
      ScalaSettings
73.  val Ypatmatdebug: BooleanSetting
    Definition Classes
      ScalaSettings
74.  val YpickleJava: BooleanSetting
    Definition Classes
      ScalaSettings
75.  val YpickleWrite: StringSetting
    Definition Classes
      ScalaSettings
76.  val YpickleWriteApiOnly: BooleanSetting
    Definition Classes
      ScalaSettings
77.  val Yposdebug: BooleanSetting
    Definition Classes
      ScalaSettings
78.  val YpresentationAnyThread: BooleanSetting
    Definition Classes
      ScalaSettings
79.  val YpresentationDebug: BooleanSetting
    Definition Classes
      ScalaSettings
80.  val YpresentationDelay: IntSetting
    Definition Classes
      ScalaSettings
81.  val YpresentationLocateSourceFile: BooleanSetting
    Definition Classes
      ScalaSettings
82.  val YpresentationLog: StringSetting
    Definition Classes
      ScalaSettings
83.  val YpresentationReplay: StringSetting
    Definition Classes
      ScalaSettings
84.  val YpresentationStrict: BooleanSetting
    Definition Classes
      ScalaSettings
85.  val YpresentationVerbose: BooleanSetting

    IDE-specific settings

    IDE-specific settings

    Definition Classes
      ScalaSettings
86.  val YprintTrees: ChoiceSetting
    Definition Classes
      ScalaSettings
87.  val YprofileDestination: StringSetting
    Definition Classes
      ScalaSettings
88.  val YprofileEnabled: BooleanSetting
    Definition Classes
      ScalaSettings
89.  val YprofileExternalTool: PhasesSetting
    Definition Classes
      ScalaSettings
90.  val YprofileRunGcBetweenPhases: PhasesSetting
    Definition Classes
      ScalaSettings
91.  val YprofileTrace: StringSetting
    Definition Classes
      ScalaSettings
92.  val Yquasiquotedebug: BooleanSetting
    Definition Classes
      ScalaSettings
93.  val Yrangepos: BooleanSetting
    Definition Classes
      ScalaSettings
94.  val Yrecursion: IntSetting
    Definition Classes
      ScalaSettings
95.  val Yreifycopypaste: BooleanSetting
    Definition Classes
      ScalaSettings
96.  val Yreifydebug: BooleanSetting
    Definition Classes
      ScalaSettings
97.  val YreplMagicImport: BooleanSetting
    Definition Classes
      ScalaSettings
98.  val Yreplclassbased: BooleanSetting
    Definition Classes
      ScalaSettings
99.  val Yreploutdir: StringSetting
    Definition Classes
      ScalaSettings
100.  val Yscriptrunner: StringSetting
     Definition Classes
       ScalaSettings
101.  val Yshow: PhasesSetting
     Definition Classes
       ScalaSettings
102.  val Yshowsymkinds: BooleanSetting
     Definition Classes
       ScalaSettings
103.  val Yshowsymowners: BooleanSetting
     Definition Classes
       ScalaSettings
104.  val Yshowsyms: BooleanSetting
     Definition Classes
       ScalaSettings
105.  val Ystatistics: PhasesSetting
     Definition Classes
       ScalaSettings
106.  val YstatisticsEnabled: BooleanSetting
     Definition Classes
       ScalaSettings
107.  val YtastyNoAnnotations: BooleanSetting
     Definition Classes
       ScalaSettings
108.  val YtastyReader: BooleanSetting
     Definition Classes
       ScalaSettings
109.  val YtrackDependencies: BooleanSetting
     Definition Classes
       ScalaSettings
110.  val Ytyperdebug: BooleanSetting
     Definition Classes
       ScalaSettings
111.  val Yvalidatepos: PhasesSetting
     Definition Classes
       ScalaSettings
112.  lazy val allSettings: LinkedHashMap[String, Setting]

     Set of settings

     Set of settings

     Attributes
       protected[scala]
     Definition Classes
       ScalaSettings
113.  final def areHotStatisticsEnabled: Boolean
     Implicit
       This member is added by an implicit conversion from Settings toSettingsOps performed by method SettingsOps in scala.reflect.internal.settings.MutableSettings.
     Definition Classes
       SettingsOps
     Annotations
       @inline()
114.  final def areStatisticsEnabled: Boolean
     Implicit
       This member is added by an implicit conversion from Settings toSettingsOps performed by method SettingsOps in scala.reflect.internal.settings.MutableSettings.
     Definition Classes
       SettingsOps
     Annotations
       @inline()
115.  final def asInstanceOf[T0]: T0
     Definition Classes
       Any
116.  val async: BooleanSetting
     Definition Classes
       ScalaSettings
117.  val bootclasspath: PathSetting

     Path related settings.

     Path related settings.

     Definition Classes
       StandardScalaSettings
118.  val breakCycles: BooleanSetting
     Definition Classes
       ScalaSettings
119.  val browse: PhasesSetting
     Definition Classes
       ScalaSettings
120.  val check: PhasesSetting
     Definition Classes
       ScalaSettings
121.  def checkDependencies: Boolean
     Definition Classes
       AbsSettings
122.  val checkInit: BooleanSetting
     Definition Classes
       ScalaSettings
123.  val classpath: PathSetting
     Definition Classes
       ScalaSettings → StandardScalaSettings
124.  def clone(): AnyRef
     Attributes
       protected[lang]
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.CloneNotSupportedException]) @native()
125.  def conflictWarning: Option[String]
     Definition Classes
       ScalaSettings
126.  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
127.  def copyInto(settings: MutableSettings): Unit
     Definition Classes
       MutableSettings
128.  val debug: BooleanSetting
     Definition Classes
       ScalaSettings
129.  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
130.  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
131.  val defines: PrefixSetting
     Definition Classes
       ScalaSettings
132.  def dependenciesFile: StringSetting
     Definition Classes
       ScalaSettings
133.  val dependencyfile: StringSetting

     Other settings.

     Other settings.

     Definition Classes
       StandardScalaSettings
134.  val deprecation: BooleanSetting
     Definition Classes
       StandardScalaSettings
135.  val developer: BooleanSetting
     Definition Classes
       ScalaSettings
136.  def disable(s: Setting): LinkedHashMap[String, Setting]

     Disable a setting

     Disable a setting

     Definition Classes
       ScalaSettings
137.  val disable: MultiStringSetting
     Definition Classes
       ScalaSettings
138.  val docAuthor: BooleanSetting
139.  val docCanonicalBaseUrl: StringSetting
140.  val docDiagrams: BooleanSetting
141.  val docDiagramsDebug: BooleanSetting
142.  val docDiagramsDotPath: PathSetting
143.  val docDiagramsDotRestart: IntSetting
144.  val docDiagramsDotTimeout: IntSetting
145.  val docDiagramsMaxImplicitClasses: IntSetting

     The maximum number of implicit classes to show in the diagram

146.  val docDiagramsMaxNormalClasses: IntSetting

     The maximum number of normal classes to show in the diagram

147.  val docExpandAllTypes: BooleanSetting
148.  val docExternalDoc: MultiStringSetting
149.  val docGroups: BooleanSetting
150.  val docImplicits: BooleanSetting
151.  val docImplicitsDebug: BooleanSetting
152.  val docImplicitsHide: MultiStringSetting
153.  val docImplicitsShowAll: BooleanSetting
154.  val docImplicitsSoundShadowing: BooleanSetting
155.  val docNoJavaComments: BooleanSetting
156.  val docNoLinkWarnings: BooleanSetting
157.  val docNoPrefixes: BooleanSetting
158.  val docRawOutput: BooleanSetting
159.  val docRootContent: PathSetting
160.  val docSkipPackages: StringSetting
161.  val docUncompilable: StringSetting
162.  val docfooter: StringSetting
163.  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`.

164.  val docgenerator: StringSetting
165.  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

166.  val doctitle: StringSetting

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

167.  val docversion: StringSetting

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

168.  val elidebelow: IntSetting
     Definition Classes
       ScalaSettings
169.  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
170.  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
171.  val encoding: StringSetting
     Definition Classes
       StandardScalaSettings
172.  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
173.  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
174.  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
175.  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
176.  final def eq(arg0: AnyRef): Boolean
     Definition Classes
       AnyRef
177.  def equals(that: Any): Boolean
     Definition Classes
       AbsSettings → AnyRef → Any
178.  val errorFn: (String) => Unit
     Definition Classes
       MutableSettings → AbsSettings
179.  val explaintypes: BooleanSetting
     Definition Classes
       StandardScalaSettings
180.  val exposeEmptyPackage: BooleanSetting
     Definition Classes
       ScalaSettings
181.  lazy val extUrlMapping: Map[String, String]
182.  val extdirs: PathSetting
     Definition Classes
       StandardScalaSettings
183.  val fatalWarnings: BooleanSetting
     Definition Classes
       Warnings
184.  val feature: BooleanSetting
     Definition Classes
       StandardScalaSettings
185.  def finalize(): Unit
     Attributes
       protected[lang]
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.Throwable])
186.  val future: BooleanSetting

     Groups of Settings.

     Groups of Settings.

     Definition Classes
       ScalaSettings
187.  val g: ChoiceSetting
     Definition Classes
       StandardScalaSettings
188.  val genPhaseGraph: StringSetting
     Definition Classes
       ScalaSettings
189.  final def getClass(): Class[_ <: AnyRef]
     Definition Classes
       AnyRef → Any
     Annotations
       @native()
190.  def hashCode(): Int
     Definition Classes
       AbsSettings → AnyRef → Any
191.  val help: BooleanSetting
     Definition Classes
       StandardScalaSettings
192.  lazy val hiddenImplicits: Set[String]
193.  val imports: MultiStringSetting
     Definition Classes
       ScalaSettings
194.  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
195.  implicit def installEnableSettings[T <: BooleanSetting](s: T): EnableSettings[T]
     Attributes
       protected
     Definition Classes
       MutableSettings
196.  final def isDebug: Boolean
     Implicit
       This member is added by an implicit conversion from Settings toSettingsOps performed by method SettingsOps in scala.reflect.internal.settings.MutableSettings.
     Definition Classes
       SettingsOps
     Annotations
       @inline()
197.  final def isDeveloper: Boolean
     Implicit
       This member is added by an implicit conversion from Settings toSettingsOps performed by method SettingsOps in scala.reflect.internal.settings.MutableSettings.
     Definition Classes
       SettingsOps
     Annotations
       @inline()
198.  def isInfo: Boolean

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

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

     Definition Classes
       ScalaSettings
199.  final def isInstanceOf[T0]: Boolean
     Definition Classes
       Any
200.  val isScala3: BooleanSetting
     Definition Classes
       ScalaSettings
201.  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
202.  val isScaladocSpecific: (String) => Boolean
203.  val javabootclasspath: PathSetting
     Definition Classes
       StandardScalaSettings
204.  val javaextdirs: PathSetting
     Definition Classes
       StandardScalaSettings
205.  val jdkApiDocBase: StringSetting
206.  val jvmargs: PrefixSetting
     Definition Classes
       ScalaSettings
207.  val language: MultiChoiceSetting[languageFeatures.type]
     Definition Classes
       ScalaSettings
208.  val lint: MultiChoiceSetting[LintWarnings.type]
     Definition Classes
       Warnings
209.  def lintDeprecation: Boolean
     Definition Classes
       Warnings
210.  def lintImplicitNotFound: Boolean
     Definition Classes
       Warnings
211.  def lintImplicitRecursion: Boolean
     Definition Classes
       Warnings
212.  def lintUnused: Boolean
     Definition Classes
       Warnings
213.  def lintValPatterns: Boolean
     Definition Classes
       Warnings
214.  val log: PhasesSetting
     Definition Classes
       ScalaSettings
215.  val logFreeTerms: BooleanSetting
     Definition Classes
       ScalaSettings
216.  val logFreeTypes: BooleanSetting
     Definition Classes
       ScalaSettings
217.  val logImplicitConv: BooleanSetting
     Definition Classes
       ScalaSettings
218.  val logReflectiveCalls: BooleanSetting
     Definition Classes
       ScalaSettings
219.  def lookupSetting(cmd: String): Option[Setting]
     Definition Classes
       AbsSettings
220.  val mainClass: StringSetting
     Definition Classes
       ScalaSettings
221.  val maxerrs: IntSetting
     Definition Classes
       ScalaSettings
222.  val maxwarns: IntSetting
     Definition Classes
       ScalaSettings
223.  def multiargInfix: Boolean
     Definition Classes
       Warnings
224.  final def ne(arg0: AnyRef): Boolean
     Definition Classes
       AnyRef
225.  val noCompletion: BooleanSetting
     Definition Classes
       ScalaSettings
226.  val noForwarders: BooleanSetting
     Definition Classes
       ScalaSettings
227.  val noassertions: settings.ScalaSettings.noassertions.stabilizer$1.type.s.type forSome {val stabilizer$1: EnableSettings[BooleanSetting]}
     Definition Classes
       ScalaSettings
228.  val nobootcp: BooleanSetting
     Definition Classes
       ScalaSettings
229.  val noimports: BooleanSetting
     Definition Classes
       ScalaSettings
230.  val nonStrictPatmatAnalysis: BooleanSetting
     Definition Classes
       ScalaSettings
231.  val nopredef: BooleanSetting
     Definition Classes
       ScalaSettings
232.  val nospecialization: BooleanSetting
     Definition Classes
       ScalaSettings
233.  final def notify(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
234.  final def notifyAll(): Unit
     Definition Classes
       AnyRef
     Annotations
       @native()
235.  val nowarn: BooleanSetting
     Definition Classes
       StandardScalaSettings
236.  def nowarnings: BooleanSetting
     Definition Classes
       ScalaSettings
237.  val opt: MultiChoiceSetting[optChoices.type]
     Definition Classes
       ScalaSettings
238.  def optAddToBytecodeRepository: Boolean
     Definition Classes
       ScalaSettings
239.  def optAllowSkipClassLoading: Boolean
     Definition Classes
       ScalaSettings
240.  def optAllowSkipCoreModuleInit: Boolean
     Definition Classes
       ScalaSettings
241.  def optAssumeModulesNonNull: Boolean
     Definition Classes
       ScalaSettings
242.  def optBoxUnbox: Boolean
     Definition Classes
       ScalaSettings
243.  def optBuildCallGraph: Boolean
     Definition Classes
       ScalaSettings
244.  def optClosureInvocations: Boolean
     Definition Classes
       ScalaSettings
245.  def optCompactLocals: Boolean
     Definition Classes
       ScalaSettings
246.  def optCopyPropagation: Boolean
     Definition Classes
       ScalaSettings
247.  val optInlineFrom: MultiStringSetting
     Definition Classes
       ScalaSettings
248.  def optInlinerEnabled: Boolean
     Definition Classes
       ScalaSettings
249.  def optNone: Boolean
     Definition Classes
       ScalaSettings
250.  def optNullnessTracking: Boolean
     Definition Classes
       ScalaSettings
251.  def optRedundantCasts: Boolean
     Definition Classes
       ScalaSettings
252.  def optSimplifyJumps: Boolean
     Definition Classes
       ScalaSettings
253.  def optUnreachableCode: Boolean
     Definition Classes
       ScalaSettings
254.  def optUseAnalyzerCache: Boolean
     Definition Classes
       ScalaSettings
255.  def optWarningEmitAtInlineFailed: Boolean
     Definition Classes
       ScalaSettings
256.  def optWarningNoInlineMissingBytecode: Boolean
     Definition Classes
       ScalaSettings
257.  def optWarningNoInlineMissingScalaInlineInfoAttr: Boolean
     Definition Classes
       ScalaSettings
258.  def optWarningNoInlineMixed: Boolean
     Definition Classes
       ScalaSettings
259.  val optWarnings: MultiChoiceSetting[optWarningsChoices.type]
     Definition Classes
       ScalaSettings
260.  def optWarningsSummaryOnly: Boolean
     Definition Classes
       ScalaSettings
261.  val optimise: BooleanSetting
     Definition Classes
       ScalaSettings → StandardScalaSettings
262.  val outdir: OutputSetting
     Definition Classes
       ScalaSettings
263.  lazy val outputDirs: OutputDirs

     A list pairing source directories with their respective output directory.

     A list pairing source directories with their respective output directory.

     Tools may set outputDirs programmatically.

     The `-d` commandline option sets a single directory for all sources.

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

     Returns any unprocessed arguments.

     Returns any unprocessed arguments.

     Attributes
       protected
     Definition Classes
       MutableSettings
265.  val pathFactory: PathFactory
     Definition Classes
       MutableSettings
266.  val plugin: MultiStringSetting
     Definition Classes
       ScalaSettings
267.  val pluginOptions: MultiStringSetting

     -P "Plugin" settings

     -P "Plugin" settings

     Definition Classes
       ScalaSettings
268.  val pluginsDir: StringSetting
     Definition Classes
       ScalaSettings
269.  lazy val prefixSettings: collection.immutable.List[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
270.  val print: BooleanSetting
     Definition Classes
       StandardScalaSettings
271.  val printArgs: StringSetting
     Definition Classes
       ScalaSettings
272.  def printLate: BooleanSetting
     Definition Classes
       ScalaSettings
273.  val printMsg: (String) => Unit
274.  val printtypes: BooleanSetting
     Definition Classes
       ScalaSettings
275.  def processArgumentString(params: String): (Boolean, List[String])
     Definition Classes
       MutableSettings
276.  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
277.  val prompt: BooleanSetting
     Definition Classes
       ScalaSettings
278.  def recreateArgs: List[String]
     Definition Classes
       AbsSettings
279.  val release: StringSetting
     Definition Classes
       ScalaSettings
280.  def releaseValue: Option[String]
     Definition Classes
       ScalaSettings
281.  val reporter: StringSetting
     Definition Classes
       ScalaSettings
282.  val require: MultiStringSetting
     Definition Classes
       ScalaSettings
283.  val resident: BooleanSetting
     Definition Classes
       ScalaSettings
284.  val rootdir: PathSetting
     Definition Classes
       StandardScalaSettings
285.  var scaladocQuietRun: Boolean
286.  def scaladocSpecific: Set[Setting]
287.  val script: StringSetting
     Definition Classes
       ScalaSettings
288.  val showPhases: BooleanSetting
     Definition Classes
       ScalaSettings
289.  val showPlugins: BooleanSetting
     Definition Classes
       ScalaSettings
290.  val skip: PhasesSetting
     Definition Classes
       ScalaSettings
291.  def skipPackage(qname: String): Boolean
292.  lazy val skipPackageNames: Set[String]
293.  val source: ScalaVersionSetting
     Definition Classes
       ScalaSettings
294.  val sourceReader: StringSetting
     Definition Classes
       ScalaSettings
295.  val sourcepath: PathSetting
     Definition Classes
       StandardScalaSettings
296.  def splitParams(line: String): List[String]

     Split the given line into parameters.

     Split the given line into parameters.

     Definition Classes
       MutableSettings
297.  val stopAfter: PhasesSetting
     Definition Classes
       ScalaSettings
298.  val stopBefore: PhasesSetting
     Definition Classes
       ScalaSettings
299.  def stripIndex(url: String): String
300.  final def synchronized[T0](arg0: => T0): T0
     Definition Classes
       AnyRef
301.  val target: ChoiceSetting
     Definition Classes
       StandardScalaSettings
302.  val termConflict: ChoiceSetting
     Definition Classes
       ScalaSettings
303.  def toConciseString: String
     Definition Classes
       AbsSettings
304.  def toString(): String
     Definition Classes
       AbsSettings → AnyRef → Any
305.  val unchecked: BooleanSetting
     Definition Classes
       StandardScalaSettings
306.  lazy val uncompilableFiles: collection.immutable.List[File]
307.  val uniqid: BooleanSetting
     Definition Classes
       StandardScalaSettings
308.  def unitSpecialization: Boolean
     Definition Classes
       Warnings
309.  val usejavacp: BooleanSetting
     Definition Classes
       StandardScalaSettings
310.  val usemanifestcp: BooleanSetting
     Definition Classes
       StandardScalaSettings
311.  def userSetSettings: List[Setting]
     Definition Classes
       AbsSettings
312.  val verbose: BooleanSetting
     Definition Classes
       StandardScalaSettings
313.  val version: BooleanSetting
     Definition Classes
       StandardScalaSettings
314.  val visibilityPrivate: BooleanSetting
315.  def visibleSettings: List[Setting]
     Definition Classes
       AbsSettings
316.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException])
317.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException])
318.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws(classOf[java.lang.InterruptedException]) @native()
319.  def warnAdaptedArgs: Boolean
     Definition Classes
       Warnings
320.  def warnByNameImplicit: Boolean
     Definition Classes
       Warnings
321.  def warnConstant: Boolean
     Definition Classes
       Warnings
322.  val warnDeadCode: BooleanSetting
     Definition Classes
       Warnings
323.  def warnDelayedInit: Boolean
     Definition Classes
       Warnings
324.  def warnDocDetached: Boolean
     Definition Classes
       Warnings
325.  def warnEtaSam: Boolean
     Definition Classes
       Warnings
326.  def warnEtaZero: Boolean
     Definition Classes
       Warnings
327.  val warnExtraImplicit: BooleanSetting
     Definition Classes
       Warnings
328.  def warnInaccessible: Boolean
     Definition Classes
       Warnings
329.  def warnInferAny: Boolean
     Definition Classes
       Warnings
330.  val warnMacros: ChoiceSetting
     Definition Classes
       Warnings
331.  def warnMissingInterpolator: Boolean
     Definition Classes
       Warnings
332.  def warnNonlocalReturn: Boolean
     Definition Classes
       Warnings
333.  def warnNullaryUnit: Boolean
     Definition Classes
       Warnings
334.  val warnNumericWiden: BooleanSetting
     Definition Classes
       Warnings
335.  val warnOctalLiteral: BooleanSetting
     Definition Classes
       Warnings
336.  def warnOptionImplicit: Boolean
     Definition Classes
       Warnings
337.  def warnPackageObjectClasses: Boolean
     Definition Classes
       Warnings
338.  def warnPolyImplicitOverload: Boolean
     Definition Classes
       Warnings
339.  def warnPrivateShadow: Boolean
     Definition Classes
       Warnings
340.  def warnRecurseWithDefault: Boolean
     Definition Classes
       Warnings
341.  def warnSerialization: Boolean
     Definition Classes
       Warnings
342.  def warnStarsAlign: Boolean
     Definition Classes
       Warnings
343.  def warnStrictUnsealedPatMat: Boolean
     Definition Classes
       Warnings
344.  def warnTypeParameterShadow: Boolean
     Definition Classes
       Warnings
345.  val warnUnused: MultiChoiceSetting[UnusedWarnings.type]
     Definition Classes
       Warnings
346.  def warnUnusedExplicits: Boolean
     Definition Classes
       Warnings
347.  def warnUnusedImplicits: Boolean
     Definition Classes
       Warnings
348.  def warnUnusedImport: Boolean
     Definition Classes
       Warnings
349.  def warnUnusedLocals: Boolean
     Definition Classes
       Warnings
350.  def warnUnusedNowarn: Boolean
     Definition Classes
       Warnings
351.  def warnUnusedParams: Boolean
     Definition Classes
       Warnings
352.  def warnUnusedPatVars: Boolean
     Definition Classes
       Warnings
353.  def warnUnusedPrivates: Boolean
     Definition Classes
       Warnings
354.  def warnUnusedSynthetics: Boolean
     Definition Classes
       Warnings
355.  val warnValueDiscard: BooleanSetting
     Definition Classes
       Warnings
356.  val warnValueOverrides: BooleanSetting
     Definition Classes
       Warnings
357.  def withErrorFn(errorFn: (String) => Unit): nsc.Settings
     Definition Classes
       Settings → MutableSettings
358.  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. :)

359.  object CachePolicy
     Definition Classes
       ScalaSettings
360.  object MacroExpand
     Definition Classes
       ScalaSettings
361.  object XxmlSettings extends MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
362.  object languageFeatures extends MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
363.  object mixinForwarderChoices
     Definition Classes
       ScalaSettings
364.  object optChoices extends MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
365.  object optWarningsChoices extends MultiChoiceEnumeration
     Definition Classes
       ScalaSettings
366.  object LintWarnings extends MultiChoiceEnumeration
     Definition Classes
       Warnings
367.  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 d: OutputSetting
   Definition Classes
     ScalaSettings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.2) Use outdir instead.

6.  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
     @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.

7.  val warnSelfImplicit: BooleanSetting
   Definition Classes
     Warnings
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.3) Use lintImplicitRecursion

8.  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 AbsSettings

### Inherited from MutableSettings

### Inherited from AbsSettings

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion SettingsOps fromSettings to SettingsOps

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