Packages

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Settings
  2. Settings
  3. MutableSettings
  4. Mutable
  5. ScalaSettings
  6. Warnings
  7. StandardScalaSettings
  8. AbsSettings
  9. MutableSettings
  10. AbsSettings
  11. AnyRef
  12. 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. All

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
    MutableSettingsAbsSettings
  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 the string "all" can be used to represent all phases. (the empty list, unless set)

    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 with Mutable

    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 to any2stringadd[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 to ArrowAssoc[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 ChoiceSettingForcedDefault(name: String, helpArg: String, descr: String, choices: List[String], supported: List[String], default: String, choicesHelp: List[String] = Nil): ChoiceSetting
    Definition Classes
    MutableSettings
  9. def IntSetting(name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) ⇒ Option[Int]): IntSetting
    Definition Classes
    MutableSettings
  10. def MultiChoiceSetting[E <: MultiChoiceEnumeration](name: String, helpArg: String, descr: String, domain: E, default: Option[List[String]] = None): MultiChoiceSetting[E]
    Definition Classes
    MutableSettings
  11. def MultiStringSetting(name: String, arg: String, descr: String, default: List[String] = Nil, helpText: Option[String] = None, prepend: Boolean = false): MultiStringSetting
    Definition Classes
    MutableSettings
  12. def OutputSetting(outputDirs: OutputDirs, default: String): OutputSetting
    Definition Classes
    MutableSettings
  13. def PathSetting(name: String, descr: String, default: String): PathSetting
    Definition Classes
    MutableSettings
  14. def PhasesSetting(name: String, descr: String, default: String = ""): PhasesSetting
    Definition Classes
    MutableSettings
  15. def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
    Definition Classes
    MutableSettings
  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] = None): StringSetting
    Definition Classes
    MutableSettings
  18. val Wconf: MultiStringSetting
    Definition Classes
    Warnings
  19. val Xexperimental: settings.ScalaSettings.Xexperimental._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
    Definition Classes
    ScalaSettings
  20. val XfullLubs: 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

    Area-specific debug output.

    Area-specific debug output.

    Definition Classes
    ScalaSettings
  44. val Ydumpclasses: StringSetting
    Definition Classes
    ScalaSettings
  45. val YforceFlatCpCaching: BooleanSetting
    Definition Classes
    ScalaSettings
  46. val Ygenasmp: StringSetting
    Definition Classes
    ScalaSettings
  47. val Yhelp: BooleanSetting
    Definition Classes
    ScalaSettings
  48. val YhotStatistics: BooleanSetting
    Definition Classes
    ScalaSettings
  49. def YhotStatisticsEnabled: Boolean
    Definition Classes
    ScalaSettings
  50. val Yidedebug: BooleanSetting
    Definition Classes
    ScalaSettings
  51. val Yissuedebug: BooleanSetting
    Definition Classes
    ScalaSettings
  52. val YjarCompressionLevel: IntSetting
    Definition Classes
    ScalaSettings
  53. val YjarFactory: StringSetting
    Definition Classes
    ScalaSettings
  54. val Ylogcp: BooleanSetting
    Definition Classes
    ScalaSettings
  55. val YmacroClasspath: PathSetting
    Definition Classes
    ScalaSettings
  56. val YmacroFresh: BooleanSetting
    Definition Classes
    ScalaSettings
  57. val YmacrodebugLite: BooleanSetting
    Definition Classes
    ScalaSettings
  58. val YmacrodebugVerbose: BooleanSetting
    Definition Classes
    ScalaSettings
  59. val Ymacroexpand: ChoiceSetting
    Definition Classes
    ScalaSettings
  60. val Ymacronoexpand: BooleanSetting
    Definition Classes
    ScalaSettings
  61. val YmaxQueue: IntSetting
    Definition Classes
    ScalaSettings
  62. val Ymemberpos: StringSetting
    Definition Classes
    ScalaSettings
  63. val YmethodInfer: BooleanSetting
    Definition Classes
    ScalaSettings
  64. val Ynogenericsig: BooleanSetting
    Definition Classes
    ScalaSettings
  65. val YoptInlineHeuristics: ChoiceSetting
    Definition Classes
    ScalaSettings
  66. val YoptLogInline: StringSetting
    Definition Classes
    ScalaSettings
  67. val YoptTrace: StringSetting
    Definition Classes
    ScalaSettings
  68. val Youtline: BooleanSetting
    Definition Classes
    ScalaSettings
  69. val YpartialUnification: BooleanSetting
    Definition Classes
    ScalaSettings
  70. val YpatmatExhaustdepth: IntSetting
    Definition Classes
    ScalaSettings
  71. val Ypatmatdebug: BooleanSetting
    Definition Classes
    ScalaSettings
  72. val YpickleJava: BooleanSetting
    Definition Classes
    ScalaSettings
  73. val YpickleWrite: StringSetting
    Definition Classes
    ScalaSettings
  74. val YpickleWriteApiOnly: BooleanSetting
    Definition Classes
    ScalaSettings
  75. val Yposdebug: BooleanSetting
    Definition Classes
    ScalaSettings
  76. val YpresentationAnyThread: BooleanSetting
    Definition Classes
    ScalaSettings
  77. val YpresentationDebug: BooleanSetting
    Definition Classes
    ScalaSettings
  78. val YpresentationDelay: IntSetting
    Definition Classes
    ScalaSettings
  79. val YpresentationLocateSourceFile: BooleanSetting
    Definition Classes
    ScalaSettings
  80. val YpresentationLog: StringSetting
    Definition Classes
    ScalaSettings
  81. val YpresentationReplay: StringSetting
    Definition Classes
    ScalaSettings
  82. val YpresentationStrict: BooleanSetting
    Definition Classes
    ScalaSettings
  83. val YpresentationVerbose: BooleanSetting

    IDE-specific settings

    IDE-specific settings

    Definition Classes
    ScalaSettings
  84. val YprofileDestination: StringSetting
    Definition Classes
    ScalaSettings
  85. val YprofileEnabled: BooleanSetting
    Definition Classes
    ScalaSettings
  86. val YprofileExternalTool: PhasesSetting
    Definition Classes
    ScalaSettings
  87. val YprofileRunGcBetweenPhases: PhasesSetting
    Definition Classes
    ScalaSettings
  88. val YprofileTrace: StringSetting
    Definition Classes
    ScalaSettings
  89. val Yquasiquotedebug: BooleanSetting
    Definition Classes
    ScalaSettings
  90. val Yrangepos: BooleanSetting
    Definition Classes
    ScalaSettings
  91. val Yrecursion: IntSetting
    Definition Classes
    ScalaSettings
  92. val Yreifycopypaste: BooleanSetting
    Definition Classes
    ScalaSettings
  93. val Yreifydebug: BooleanSetting
    Definition Classes
    ScalaSettings
  94. val YreplMagicImport: BooleanSetting
    Definition Classes
    ScalaSettings
  95. val Yreplclassbased: BooleanSetting
    Definition Classes
    ScalaSettings
  96. val Yreploutdir: StringSetting
    Definition Classes
    ScalaSettings
  97. val Yreplsync: BooleanSetting
    Definition Classes
    ScalaSettings
  98. val Yshow: PhasesSetting
    Definition Classes
    ScalaSettings
  99. val Yshowsymkinds: BooleanSetting
    Definition Classes
    ScalaSettings
  100. val Yshowsymowners: BooleanSetting
    Definition Classes
    ScalaSettings
  101. val Yshowsyms: BooleanSetting
    Definition Classes
    ScalaSettings
  102. val Ystatistics: PhasesSetting
    Definition Classes
    ScalaSettings
  103. def YstatisticsEnabled: Boolean
    Definition Classes
    ScalaSettings
  104. val YtrackDependencies: BooleanSetting
    Definition Classes
    ScalaSettings
  105. val Ytyperdebug: BooleanSetting
    Definition Classes
    ScalaSettings
  106. val Yvalidatepos: PhasesSetting
    Definition Classes
    ScalaSettings
  107. val Yvirtpatmat: BooleanSetting
    Definition Classes
    ScalaSettings
  108. lazy val allSettings: LinkedHashMap[String, Setting]

    Set of settings

    Set of settings

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

    Path related settings.

    Path related settings.

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

    Other settings.

    Other settings.

    Definition Classes
    StandardScalaSettings
  131. val deprecation: BooleanSetting
    Definition Classes
    StandardScalaSettings
  132. val developer: BooleanSetting
    Definition Classes
    ScalaSettings
  133. def disable(s: Setting): LinkedHashMap[String, Setting]

    Disable a setting

    Disable a setting

    Definition Classes
    ScalaSettings
  134. val disable: MultiStringSetting
    Definition Classes
    ScalaSettings
  135. val docAuthor: BooleanSetting
  136. val docCanonicalBaseUrl: StringSetting
  137. val docDiagrams: BooleanSetting
  138. val docDiagramsDebug: BooleanSetting
  139. val docDiagramsDotPath: PathSetting
  140. val docDiagramsDotRestart: IntSetting
  141. val docDiagramsDotTimeout: IntSetting
  142. val docDiagramsMaxImplicitClasses: IntSetting

    The maximum number of implicit classes to show in the diagram

  143. val docDiagramsMaxNormalClasses: IntSetting

    The maximum number of normal classes to show in the diagram

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

  161. val docgenerator: StringSetting
  162. 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

  163. val doctitle: StringSetting

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

  164. val docversion: StringSetting

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

  165. val elidebelow: IntSetting
    Definition Classes
    ScalaSettings
  166. 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
  167. 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
  168. val encoding: StringSetting
    Definition Classes
    StandardScalaSettings
  169. def ensuring(cond: (Settings) ⇒ Boolean, msg: ⇒ Any): Settings
    Implicit
    This member is added by an implicit conversion from Settings to Ensuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  170. def ensuring(cond: (Settings) ⇒ Boolean): Settings
    Implicit
    This member is added by an implicit conversion from Settings to Ensuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  171. def ensuring(cond: Boolean, msg: ⇒ Any): Settings
    Implicit
    This member is added by an implicit conversion from Settings to Ensuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  172. def ensuring(cond: Boolean): Settings
    Implicit
    This member is added by an implicit conversion from Settings to Ensuring[Settings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  173. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  174. def equals(that: Any): Boolean
    Definition Classes
    AbsSettings → AnyRef → Any
  175. val errorFn: (String) ⇒ Unit
    Definition Classes
    MutableSettingsAbsSettings
  176. def experimentalSettings: collection.immutable.List[BooleanSetting]

    Enabled under -Xexperimental.

    Enabled under -Xexperimental.

    Attributes
    protected
    Definition Classes
    ScalaSettings
  177. val explaintypes: BooleanSetting
    Definition Classes
    StandardScalaSettings
  178. val exposeEmptyPackage: BooleanSetting
    Definition Classes
    ScalaSettings
  179. lazy val extUrlMapping: Map[String, String]
  180. val extdirs: PathSetting
    Definition Classes
    StandardScalaSettings
  181. val fatalWarnings: BooleanSetting
    Definition Classes
    Warnings
  182. val feature: BooleanSetting
    Definition Classes
    StandardScalaSettings
  183. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  184. val future: settings.ScalaSettings.future._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}

    Groups of Settings.

    Groups of Settings.

    Definition Classes
    ScalaSettings
  185. def futureSettings: collection.immutable.List[BooleanSetting]

    Enabled under -Xfuture.

    Enabled under -Xfuture.

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

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

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

    Definition Classes
    ScalaSettings
  197. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  198. def isScala211: Boolean
    Definition Classes
    ScalaSettings
  199. def isScala212: Boolean
    Definition Classes
    ScalaSettings
  200. def isScala213: Boolean
    Definition Classes
    ScalaSettings
  201. def isScala3: Boolean
    Definition Classes
    ScalaSettings
  202. def isScaladoc: Boolean

    Test whether this is scaladoc we're looking at

    Test whether this is scaladoc we're looking at

    Definition Classes
    SettingsScalaSettings
  203. val isScaladocSpecific: (String) ⇒ Boolean
  204. val javabootclasspath: PathSetting
    Definition Classes
    StandardScalaSettings
  205. val javaextdirs: PathSetting
    Definition Classes
    StandardScalaSettings
  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 lintUnused: Boolean
    Definition Classes
    Warnings
  211. val log: PhasesSetting
    Definition Classes
    ScalaSettings
  212. val logFreeTerms: BooleanSetting
    Definition Classes
    ScalaSettings
  213. val logFreeTypes: BooleanSetting
    Definition Classes
    ScalaSettings
  214. val logImplicitConv: BooleanSetting
    Definition Classes
    ScalaSettings
  215. val logReflectiveCalls: BooleanSetting
    Definition Classes
    ScalaSettings
  216. def lookupSetting(cmd: String): Option[Setting]
    Definition Classes
    AbsSettings
  217. val mainClass: StringSetting
    Definition Classes
    ScalaSettings
  218. val maxClassfileName: IntSetting
    Definition Classes
    ScalaSettings
  219. val maxerrs: IntSetting
    Definition Classes
    ScalaSettings
  220. val maxwarns: IntSetting
    Definition Classes
    ScalaSettings
  221. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  222. val noAdaptedArgs: BooleanSetting
    Definition Classes
    ScalaSettings
  223. val noCompletion: BooleanSetting
    Definition Classes
    ScalaSettings
  224. val noForwarders: BooleanSetting
    Definition Classes
    ScalaSettings
  225. val noassertions: settings.ScalaSettings.noassertions._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
    Definition Classes
    ScalaSettings
  226. val nobootcp: BooleanSetting
    Definition Classes
    ScalaSettings
  227. val noimports: BooleanSetting
    Definition Classes
    ScalaSettings
  228. val nopredef: BooleanSetting
    Definition Classes
    ScalaSettings
  229. val nospecialization: BooleanSetting
    Definition Classes
    ScalaSettings
  230. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  231. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  232. val nouescape: BooleanSetting
    Definition Classes
    ScalaSettings
  233. val nowarn: BooleanSetting
    Definition Classes
    StandardScalaSettings
  234. def nowarnings: BooleanSetting
    Definition Classes
    ScalaSettings
  235. val opt: MultiChoiceSetting[optChoices.type]
    Definition Classes
    ScalaSettings
  236. def optAddToBytecodeRepository: Boolean
    Definition Classes
    ScalaSettings
  237. def optBoxUnbox: Boolean
    Definition Classes
    ScalaSettings
  238. def optBuildCallGraph: Boolean
    Definition Classes
    ScalaSettings
  239. def optClosureInvocations: Boolean
    Definition Classes
    ScalaSettings
  240. def optCompactLocals: Boolean
    Definition Classes
    ScalaSettings
  241. def optCopyPropagation: Boolean
    Definition Classes
    ScalaSettings
  242. val optInlineFrom: MultiStringSetting
    Definition Classes
    ScalaSettings
  243. def optInlinerEnabled: Boolean
    Definition Classes
    ScalaSettings
  244. def optLClasspath: Boolean
    Definition Classes
    ScalaSettings
  245. def optLProject: Boolean
    Definition Classes
    ScalaSettings
  246. def optNone: Boolean
    Definition Classes
    ScalaSettings
  247. def optNullnessTracking: Boolean
    Definition Classes
    ScalaSettings
  248. def optRedundantCasts: Boolean
    Definition Classes
    ScalaSettings
  249. def optSimplifyJumps: Boolean
    Definition Classes
    ScalaSettings
  250. def optUnreachableCode: Boolean
    Definition Classes
    ScalaSettings
  251. def optWarningEmitAtInlineFailed: Boolean
    Definition Classes
    ScalaSettings
  252. def optWarningNoInlineMissingBytecode: Boolean
    Definition Classes
    ScalaSettings
  253. def optWarningNoInlineMissingScalaInlineInfoAttr: Boolean
    Definition Classes
    ScalaSettings
  254. def optWarningNoInlineMixed: Boolean
    Definition Classes
    ScalaSettings
  255. val optWarnings: MultiChoiceSetting[optWarningsChoices.type]
    Definition Classes
    ScalaSettings
  256. def optWarningsSummaryOnly: Boolean
    Definition Classes
    ScalaSettings
  257. val optimise: BooleanSetting
    Definition Classes
    ScalaSettingsStandardScalaSettings
  258. def outdir: OutputSetting
    Definition Classes
    ScalaSettings
  259. 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
  260. val overrideObjects: BooleanSetting

    -Y "Private" settings

    -Y "Private" settings

    Definition Classes
    ScalaSettings
  261. val overrideVars: BooleanSetting
    Definition Classes
    ScalaSettings
  262. def parseParams(args: List[String]): List[String]

    Returns any unprocessed arguments.

    Returns any unprocessed arguments.

    Attributes
    protected
    Definition Classes
    MutableSettings
  263. val pathFactory: PathFactory
    Definition Classes
    MutableSettings
  264. val plugin: MultiStringSetting
    Definition Classes
    ScalaSettings
  265. val pluginOptions: MultiStringSetting

    -P "Plugin" settings

    -P "Plugin" settings

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

    Split the given line into parameters.

    Split the given line into parameters.

    Definition Classes
    MutableSettings
  295. val stopAfter: PhasesSetting
    Definition Classes
    ScalaSettings
  296. val stopBefore: PhasesSetting
    Definition Classes
    ScalaSettings
  297. val strictInference: BooleanSetting
    Definition Classes
    ScalaSettings
  298. def stripIndex(url: String): String
  299. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  300. val target: ChoiceSetting
    Definition Classes
    StandardScalaSettings
  301. val termConflict: ChoiceSetting
    Definition Classes
    ScalaSettings
  302. def toConciseString: String
    Definition Classes
    AbsSettings
  303. def toString(): String
    Definition Classes
    AbsSettings → AnyRef → Any
  304. val unchecked: BooleanSetting
    Definition Classes
    StandardScalaSettings
  305. lazy val uncompilableFiles: List[File]
  306. val uniqid: BooleanSetting
    Definition Classes
    StandardScalaSettings
  307. val useStupidTypes: BooleanSetting
  308. val usejavacp: BooleanSetting
    Definition Classes
    StandardScalaSettings
  309. val usemanifestcp: BooleanSetting
    Definition Classes
    StandardScalaSettings
  310. def userSetSettings: List[Setting]
    Definition Classes
    AbsSettings
  311. val verbose: BooleanSetting
    Definition Classes
    StandardScalaSettings
  312. val version: BooleanSetting
    Definition Classes
    StandardScalaSettings
  313. def visibleSettings: List[Setting]
    Definition Classes
    AbsSettings
  314. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  315. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  316. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  317. def warnAdaptedArgs: Boolean
    Definition Classes
    Warnings
  318. def warnByNameRightAssociative: Boolean
    Definition Classes
    Warnings
  319. def warnConstant: Boolean
    Definition Classes
    Warnings
  320. val warnDeadCode: BooleanSetting
    Definition Classes
    Warnings
  321. def warnDelayedInit: Boolean
    Definition Classes
    Warnings
  322. def warnDocDetached: Boolean
    Definition Classes
    Warnings
  323. val warnExtraImplicit: BooleanSetting
    Definition Classes
    Warnings
  324. def warnInaccessible: Boolean
    Definition Classes
    Warnings
  325. def warnInferAny: Boolean
    Definition Classes
    Warnings
  326. val warnMacros: ChoiceSetting
    Definition Classes
    Warnings
  327. def warnMissingInterpolator: Boolean
    Definition Classes
    Warnings
  328. def warnNullaryOverride: Boolean
    Definition Classes
    Warnings
  329. def warnNullaryUnit: Boolean
    Definition Classes
    Warnings
  330. val warnNumericWiden: BooleanSetting
    Definition Classes
    Warnings
  331. def warnOptionImplicit: Boolean
    Definition Classes
    Warnings
  332. def warnPackageObjectClasses: Boolean
    Definition Classes
    Warnings
  333. def warnPolyImplicitOverload: Boolean
    Definition Classes
    Warnings
  334. def warnPrivateShadow: Boolean
    Definition Classes
    Warnings
  335. val warnSelfImplicit: BooleanSetting
    Definition Classes
    Warnings
  336. def warnStarsAlign: Boolean
    Definition Classes
    Warnings
  337. def warnTypeParameterShadow: Boolean
    Definition Classes
    Warnings
  338. def warnUnsoundMatch: Boolean
    Definition Classes
    Warnings
  339. val warnUnused: MultiChoiceSetting[UnusedWarnings.type]
    Definition Classes
    Warnings
  340. def warnUnusedExplicits: Boolean
    Definition Classes
    Warnings
  341. def warnUnusedImplicits: Boolean
    Definition Classes
    Warnings
  342. def warnUnusedImport: Boolean
    Definition Classes
    Warnings
  343. def warnUnusedLocals: Boolean
    Definition Classes
    Warnings
  344. def warnUnusedNowarn: Boolean
    Definition Classes
    Warnings
  345. def warnUnusedParams: Boolean
    Definition Classes
    Warnings
  346. def warnUnusedPatVars: Boolean
    Definition Classes
    Warnings
  347. def warnUnusedPrivates: Boolean
    Definition Classes
    Warnings
  348. val warnValueDiscard: BooleanSetting
    Definition Classes
    Warnings
  349. val warnValueOverrides: BooleanSetting
    Definition Classes
    Warnings
  350. def withErrorFn(errorFn: (String) ⇒ Unit): nsc.Settings
    Definition Classes
    SettingsMutableSettings
  351. def [B](y: B): (Settings, B)
    Implicit
    This member is added by an implicit conversion from Settings to ArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
  352. 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. :)

  353. object CachePolicy
    Definition Classes
    ScalaSettings
  354. object MacroExpand
    Definition Classes
    ScalaSettings
  355. object XxmlSettings extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  356. object languageFeatures extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  357. object mixinForwarderChoices
    Definition Classes
    ScalaSettings
  358. object optChoices extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  359. object optWarningsChoices extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  360. object LintWarnings extends MultiChoiceEnumeration
    Definition Classes
    Warnings
  361. 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. def YwarnAdaptedArgs: Boolean
    Definition Classes
    Warnings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.2) Use warnAdaptedArgs

  4. def YwarnInaccessible: Boolean
    Definition Classes
    Warnings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.2) Use warnInaccessible

  5. def YwarnInferAny: Boolean
    Definition Classes
    Warnings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.2) Use warnInferAny

  6. def YwarnNullaryOverride: Boolean
    Definition Classes
    Warnings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.2) Use warnNullaryOverride

  7. def YwarnNullaryUnit: Boolean
    Definition Classes
    Warnings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.2) Use warnNullaryUnit

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

    (Since version 2.11.0) Use warnDeadCode

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

Inherited from nsc.Settings

Inherited from MutableSettings

Inherited from Mutable

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 from Settings to SettingsOps

Inherited by implicit conversion any2stringadd from Settings to any2stringadd[Settings]

Inherited by implicit conversion StringFormat from Settings to StringFormat[Settings]

Inherited by implicit conversion Ensuring from Settings to Ensuring[Settings]

Inherited by implicit conversion ArrowAssoc from Settings to ArrowAssoc[Settings]

Ungrouped