Packages

class Settings extends nsc.Settings

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

Source
Settings.scala
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
    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 IntSetting extends Setting

    A setting represented by an integer.

    A setting represented by an integer.

    Definition Classes
    MutableSettings
  9. 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
  10. 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
  11. 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
  12. 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
  13. class OutputSetting extends StringSetting

    Set the output directory for all sources.

    Set the output directory for all sources.

    Definition Classes
    MutableSettings
  14. class PathSetting extends StringSetting
    Definition Classes
    MutableSettings
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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
  20. sealed abstract class CachePolicy extends AnyRef
    Definition Classes
    ScalaSettings

Value Members

  1. def BooleanSetting(name: String, descr: String, default: Boolean = false): BooleanSetting
    Definition Classes
    MutableSettings
  2. def ChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: String, choicesHelp: List[String] = Nil): ChoiceSetting
    Definition Classes
    MutableSettings
  3. def IntSetting(name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) => Option[Int]): IntSetting
    Definition Classes
    MutableSettings
  4. def MultiChoiceSetting[E <: MultiChoiceEnumeration](name: String, helpArg: String, descr: String, domain: E, default: Option[List[String]] = None, helpText: Option[String] = None): MultiChoiceSetting[E]
    Definition Classes
    MutableSettings
  5. def MultiStringSetting(name: String, arg: String, descr: String, default: List[String] = Nil, helpText: Option[String] = None, prepend: Boolean = false): MultiStringSetting
    Definition Classes
    MutableSettings
  6. def OutputSetting(default: String): OutputSetting
    Definition Classes
    MutableSettings
  7. def PathSetting(name: String, descr: String, default: String): PathSetting
    Definition Classes
    MutableSettings
  8. def PhasesSetting(name: String, descr: String, default: String = ""): PhasesSetting
    Definition Classes
    MutableSettings
  9. def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
    Definition Classes
    MutableSettings
  10. def ScalaVersionSetting(name: String, arg: String, descr: String, initial: ScalaVersion, default: Option[ScalaVersion] = None, helpText: Option[String] = None): ScalaVersionSetting
    Definition Classes
    MutableSettings
  11. def StringSetting(name: String, arg: String, descr: String, default: String = "", helpText: Option[String] = None): StringSetting
    Definition Classes
    MutableSettings
  12. val VdebugTypeError: BooleanSetting
    Definition Classes
    ScalaSettings
  13. val Vhelp: BooleanSetting

    -V "Verbose" settings

    -V "Verbose" settings

    Definition Classes
    ScalaSettings
  14. val Vimplicits: BooleanSetting
    Definition Classes
    ScalaSettings
  15. val VimplicitsMaxRefined: IntSetting
    Definition Classes
    ScalaSettings
  16. val VimplicitsVerboseTree: BooleanSetting
    Definition Classes
    ScalaSettings
  17. val VtypeDiffs: BooleanSetting
    Definition Classes
    ScalaSettings
  18. val Wconf: MultiStringSetting
    Definition Classes
    Warnings
  19. val WconfDefault: collection.immutable.List[String]
    Definition Classes
    Warnings
  20. val Whelp: BooleanSetting
    Definition Classes
    Warnings
  21. val Xexperimental: BooleanSetting
    Definition Classes
    ScalaSettings
  22. val Xhelp: BooleanSetting

    -X "Advanced" settings

    -X "Advanced" settings

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

    -Y "Private" settings

    -Y "Private" settings

    Definition Classes
    ScalaSettings
  52. val YhotStatisticsEnabled: BooleanSetting
    Definition Classes
    ScalaSettings
  53. val Yidedebug: BooleanSetting
    Definition Classes
    ScalaSettings
  54. val YjarCompressionLevel: IntSetting
    Definition Classes
    ScalaSettings
  55. val YjarFactory: StringSetting
    Definition Classes
    ScalaSettings
  56. val Ylogcp: BooleanSetting
    Definition Classes
    ScalaSettings
  57. val YmacroAnnotations: BooleanSetting
    Definition Classes
    ScalaSettings
  58. val YmacroClasspath: PathSetting
    Definition Classes
    ScalaSettings
  59. val YmacroFresh: BooleanSetting
    Definition Classes
    ScalaSettings
  60. val YmacrodebugLite: BooleanSetting
    Definition Classes
    ScalaSettings
  61. val YmacrodebugVerbose: BooleanSetting
    Definition Classes
    ScalaSettings
  62. val Ymacroexpand: ChoiceSetting
    Definition Classes
    ScalaSettings
  63. val YmaxQueue: IntSetting
    Definition Classes
    ScalaSettings
  64. val Ymemberpos: StringSetting
    Definition Classes
    ScalaSettings
  65. val Ynogenericsig: BooleanSetting
    Definition Classes
    ScalaSettings
  66. val YoptInlineHeuristics: ChoiceSetting
    Definition Classes
    ScalaSettings
  67. val YoptLogInline: StringSetting
    Definition Classes
    ScalaSettings
  68. val YoptTrace: StringSetting
    Definition Classes
    ScalaSettings
  69. val Youtline: 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 YprintTrees: ChoiceSetting
    Definition Classes
    ScalaSettings
  85. val YprofileDestination: StringSetting
    Definition Classes
    ScalaSettings
  86. val YprofileEnabled: BooleanSetting
    Definition Classes
    ScalaSettings
  87. val YprofileExternalTool: PhasesSetting
    Definition Classes
    ScalaSettings
  88. val YprofileRunGcBetweenPhases: PhasesSetting
    Definition Classes
    ScalaSettings
  89. val YprofileTrace: StringSetting
    Definition Classes
    ScalaSettings
  90. val Yquasiquotedebug: BooleanSetting
    Definition Classes
    ScalaSettings
  91. val Yrangepos: BooleanSetting
    Definition Classes
    ScalaSettings
  92. val Yrecursion: IntSetting
    Definition Classes
    ScalaSettings
  93. val Yreifycopypaste: BooleanSetting
    Definition Classes
    ScalaSettings
  94. val Yreifydebug: BooleanSetting
    Definition Classes
    ScalaSettings
  95. val YreplMagicImport: BooleanSetting
    Definition Classes
    ScalaSettings
  96. val Yreplclassbased: BooleanSetting
    Definition Classes
    ScalaSettings
  97. val Yreploutdir: StringSetting
    Definition Classes
    ScalaSettings
  98. val Yscala3ImplicitResolution: BooleanSetting
    Definition Classes
    ScalaSettings
  99. val Yscriptrunner: StringSetting
    Definition Classes
    ScalaSettings
  100. val Yshow: PhasesSetting
    Definition Classes
    ScalaSettings
  101. val Yshowsymkinds: BooleanSetting
    Definition Classes
    ScalaSettings
  102. val Yshowsymowners: BooleanSetting
    Definition Classes
    ScalaSettings
  103. val Yshowsyms: BooleanSetting
    Definition Classes
    ScalaSettings
  104. val Ystatistics: PhasesSetting
    Definition Classes
    ScalaSettings
  105. val YstatisticsEnabled: BooleanSetting
    Definition Classes
    ScalaSettings
  106. val YtastyNoAnnotations: BooleanSetting
    Definition Classes
    ScalaSettings
  107. val YtastyReader: BooleanSetting
    Definition Classes
    ScalaSettings
  108. val YtrackDependencies: BooleanSetting
    Definition Classes
    ScalaSettings
  109. val Ytyperdebug: BooleanSetting
    Definition Classes
    ScalaSettings
  110. val Yvalidatepos: PhasesSetting
    Definition Classes
    ScalaSettings
  111. 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()
  112. 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()
  113. val async: BooleanSetting
    Definition Classes
    ScalaSettings
  114. val bootclasspath: PathSetting

    Path related settings.

    Path related settings.

    Definition Classes
    StandardScalaSettings
  115. val breakCycles: BooleanSetting
    Definition Classes
    ScalaSettings
  116. val browse: PhasesSetting
    Definition Classes
    ScalaSettings
  117. val check: PhasesSetting
    Definition Classes
    ScalaSettings
  118. def checkDependencies: Boolean
    Definition Classes
    AbsSettings
  119. val checkInit: BooleanSetting
    Definition Classes
    ScalaSettings
  120. val classpath: PathSetting
    Definition Classes
    ScalaSettingsStandardScalaSettings
  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 cyclic: BooleanSetting
    Definition Classes
    ScalaSettings
  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. val defines: PrefixSetting
    Definition Classes
    ScalaSettings
  128. def dependenciesFile: StringSetting
    Definition Classes
    ScalaSettings
  129. val dependencyfile: StringSetting

    Other settings.

    Other settings.

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

    Disable a setting

    Disable a setting

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

    The maximum number of implicit classes to show in the diagram

  142. val docDiagramsMaxNormalClasses: IntSetting

    The maximum number of normal classes to show in the diagram

  143. val docExpandAllTypes: BooleanSetting
  144. val docExternalDoc: MultiStringSetting
  145. val docGroups: BooleanSetting
  146. val docImplicits: BooleanSetting
  147. val docImplicitsDebug: BooleanSetting
  148. val docImplicitsHide: MultiStringSetting
  149. val docImplicitsShowAll: BooleanSetting
  150. val docImplicitsSoundShadowing: BooleanSetting
  151. val docNoJavaComments: BooleanSetting
  152. val docNoLinkWarnings: BooleanSetting
  153. val docNoPrefixes: BooleanSetting
  154. val docRawOutput: BooleanSetting
  155. val docRequired: 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 equals(that: Any): Boolean
    Definition Classes
    AbsSettings → AnyRef → Any
  170. val errorFn: (String) => Unit
    Definition Classes
    MutableSettingsAbsSettings
  171. val explaintypes: BooleanSetting
    Definition Classes
    StandardScalaSettings
  172. val exposeEmptyPackage: BooleanSetting
    Definition Classes
    ScalaSettings
  173. lazy val extUrlMapping: Map[String, String]
  174. val extdirs: PathSetting
    Definition Classes
    StandardScalaSettings
  175. val fatalWarnings: BooleanSetting
    Definition Classes
    Warnings
  176. val feature: BooleanSetting
    Definition Classes
    StandardScalaSettings
  177. val future: BooleanSetting

    Groups of Settings.

    Groups of Settings.

    Definition Classes
    ScalaSettings
  178. val g: ChoiceSetting
    Definition Classes
    StandardScalaSettings
  179. val genPhaseGraph: StringSetting
    Definition Classes
    ScalaSettings
  180. def hashCode(): Int
    Definition Classes
    AbsSettings → AnyRef → Any
  181. val help: BooleanSetting
    Definition Classes
    StandardScalaSettings
  182. lazy val hiddenImplicits: Set[String]
  183. val imports: MultiStringSetting
    Definition Classes
    ScalaSettings
  184. 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
  185. def inlineHelp: String
    Definition Classes
    ScalaSettings
  186. 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()
  187. 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()
  188. def isInfo: Boolean

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

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

    Definition Classes
    ScalaSettings
  189. def isScaladoc: Boolean

    Test whether this is scaladoc we're looking at

    Test whether this is scaladoc we're looking at

    Definition Classes
    SettingsScalaSettings
  190. val isScaladocSpecific: (String) => Boolean
  191. val javabootclasspath: PathSetting
    Definition Classes
    StandardScalaSettings
  192. val javaextdirs: PathSetting
    Definition Classes
    StandardScalaSettings
  193. val jdkApiDocBase: StringSetting
  194. val jvmargs: PrefixSetting
    Definition Classes
    ScalaSettings
  195. val language: MultiChoiceSetting[languageFeatures.type]
    Definition Classes
    ScalaSettings
  196. val lint: MultiChoiceSetting[LintWarnings.type]
    Definition Classes
    Warnings
  197. def lintArgDiscard: Boolean
    Definition Classes
    Warnings
  198. def lintDeprecation: Boolean
    Definition Classes
    Warnings
  199. def lintImplicitNotFound: Boolean
    Definition Classes
    Warnings
  200. def lintImplicitRecursion: Boolean
    Definition Classes
    Warnings
  201. def lintIntDivToFloat: Boolean
    Definition Classes
    Warnings
  202. def lintNumericMethods: Boolean
    Definition Classes
    Warnings
  203. def lintUniversalMethods: Boolean
    Definition Classes
    Warnings
  204. def lintUnused: Boolean
    Definition Classes
    Warnings
  205. def lintValPatterns: Boolean
    Definition Classes
    Warnings
  206. val log: PhasesSetting
    Definition Classes
    ScalaSettings
  207. val logFreeTerms: BooleanSetting
    Definition Classes
    ScalaSettings
  208. val logFreeTypes: BooleanSetting
    Definition Classes
    ScalaSettings
  209. val logImplicitConv: BooleanSetting
    Definition Classes
    ScalaSettings
  210. val logReflectiveCalls: BooleanSetting
    Definition Classes
    ScalaSettings
  211. def lookupSetting(cmd: String): Option[Setting]
    Definition Classes
    AbsSettings
  212. val mainClass: StringSetting
    Definition Classes
    ScalaSettings
  213. val maxerrs: IntSetting
    Definition Classes
    ScalaSettings
  214. val maxwarns: IntSetting
    Definition Classes
    ScalaSettings
  215. def multiargInfix: Boolean
    Definition Classes
    Warnings
  216. val noCompletion: BooleanSetting
    Definition Classes
    ScalaSettings
  217. val noForwarders: BooleanSetting
    Definition Classes
    ScalaSettings
  218. val noassertions: settings.ScalaSettings.noassertions.stabilizer$1.type.s.type forSome {val stabilizer$1: EnableSettings[BooleanSetting]}
    Definition Classes
    ScalaSettings
  219. val nobootcp: BooleanSetting
    Definition Classes
    ScalaSettings
  220. val noimports: BooleanSetting
    Definition Classes
    ScalaSettings
  221. val nonStrictPatmatAnalysis: BooleanSetting
    Definition Classes
    ScalaSettings
  222. val nopredef: BooleanSetting
    Definition Classes
    ScalaSettings
  223. val nospecialization: BooleanSetting
    Definition Classes
    ScalaSettings
  224. val nowarn: BooleanSetting
    Definition Classes
    StandardScalaSettings
  225. def nowarnings: BooleanSetting
    Definition Classes
    ScalaSettings
  226. val opt: MultiChoiceSetting[optChoices.type]
    Definition Classes
    ScalaSettings
  227. def optAddToBytecodeRepository: Boolean
    Definition Classes
    ScalaSettings
  228. def optAllowSkipClassLoading: Boolean
    Definition Classes
    ScalaSettings
  229. def optAllowSkipCoreModuleInit: Boolean
    Definition Classes
    ScalaSettings
  230. def optAssumeModulesNonNull: Boolean
    Definition Classes
    ScalaSettings
  231. def optBoxUnbox: Boolean
    Definition Classes
    ScalaSettings
  232. def optBuildCallGraph: Boolean
    Definition Classes
    ScalaSettings
  233. def optClosureInvocations: Boolean
    Definition Classes
    ScalaSettings
  234. def optCompactLocals: Boolean
    Definition Classes
    ScalaSettings
  235. def optCopyPropagation: Boolean
    Definition Classes
    ScalaSettings
  236. def optInlineFrom: List[String]
    Definition Classes
    ScalaSettings
  237. def optInlinerEnabled: Boolean
    Definition Classes
    ScalaSettings
  238. def optNone: Boolean
    Definition Classes
    ScalaSettings
  239. def optNullnessTracking: Boolean
    Definition Classes
    ScalaSettings
  240. def optRedundantCasts: Boolean
    Definition Classes
    ScalaSettings
  241. def optSimplifyJumps: Boolean
    Definition Classes
    ScalaSettings
  242. def optUnreachableCode: Boolean
    Definition Classes
    ScalaSettings
  243. def optUseAnalyzerCache: Boolean
    Definition Classes
    ScalaSettings
  244. def optWarningEmitAtInlineFailed: Boolean
    Definition Classes
    ScalaSettings
  245. def optWarningNoInlineMissingBytecode: Boolean
    Definition Classes
    ScalaSettings
  246. def optWarningNoInlineMissingScalaInlineInfoAttr: Boolean
    Definition Classes
    ScalaSettings
  247. def optWarningNoInlineMixed: Boolean
    Definition Classes
    ScalaSettings
  248. val optWarnings: MultiChoiceSetting[optWarningsChoices.type]
    Definition Classes
    ScalaSettings
  249. def optWarningsSummaryOnly: Boolean
    Definition Classes
    ScalaSettings
  250. val optimise: BooleanSetting
    Definition Classes
    ScalaSettingsStandardScalaSettings
  251. val outdir: OutputSetting
    Definition Classes
    ScalaSettings
  252. 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
  253. val pathFactory: PathFactory
    Definition Classes
    MutableSettings
  254. val plugin: MultiStringSetting
    Definition Classes
    ScalaSettings
  255. val pluginOptions: MultiStringSetting

    -P "Plugin" settings

    -P "Plugin" settings

    Definition Classes
    ScalaSettings
  256. val pluginsDir: StringSetting
    Definition Classes
    ScalaSettings
  257. 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
  258. val print: BooleanSetting
    Definition Classes
    StandardScalaSettings
  259. val printArgs: StringSetting
    Definition Classes
    ScalaSettings
  260. def printLate: BooleanSetting
    Definition Classes
    ScalaSettings
  261. val printMsg: (String) => Unit
  262. val printtypes: BooleanSetting
    Definition Classes
    ScalaSettings
  263. def processArgumentString(params: String): (Boolean, List[String])
    Definition Classes
    MutableSettings
  264. 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
  265. val prompt: BooleanSetting
    Definition Classes
    ScalaSettings
  266. def quickFixSilent: Boolean
    Definition Classes
    StandardScalaSettings
  267. val quickfix: MultiStringSetting
    Definition Classes
    StandardScalaSettings
  268. def recreateArgs: List[String]
    Definition Classes
    AbsSettings
  269. val release: ChoiceSetting
    Definition Classes
    StandardScalaSettings
  270. def releaseValue: Option[String]
    Definition Classes
    StandardScalaSettings
  271. val reporter: StringSetting
    Definition Classes
    ScalaSettings
  272. val require: MultiStringSetting
    Definition Classes
    ScalaSettings
  273. val resident: BooleanSetting
    Definition Classes
    ScalaSettings
  274. val rootdir: PathSetting
    Definition Classes
    StandardScalaSettings
  275. def scalaDocSpecific: Set[Setting]
  276. var scaladocQuietRun: Boolean
  277. val script: StringSetting
    Definition Classes
    ScalaSettings
  278. val showPhases: BooleanSetting
    Definition Classes
    ScalaSettings
  279. val showPlugins: BooleanSetting
    Definition Classes
    ScalaSettings
  280. def showTreeDiff: Boolean
    Definition Classes
    ScalaSettings
  281. val skip: PhasesSetting
    Definition Classes
    ScalaSettings
  282. def skipPackage(qname: String): Boolean
  283. lazy val skipPackageNames: Set[String]
  284. val source: ScalaVersionSetting
    Definition Classes
    ScalaSettings
    Annotations
    @nowarn()
  285. val sourceReader: StringSetting
    Definition Classes
    ScalaSettings
  286. val sourcepath: PathSetting
    Definition Classes
    StandardScalaSettings
  287. def splitParams(line: String): List[String]

    Split the given line into parameters.

    Split the given line into parameters.

    Definition Classes
    MutableSettings
  288. val stopAfter: PhasesSetting
    Definition Classes
    ScalaSettings
  289. val stopBefore: PhasesSetting
    Definition Classes
    ScalaSettings
  290. def stripIndex(url: String): String
  291. val systemPath: PathSetting
    Definition Classes
    StandardScalaSettings
  292. def systemPathValue: Option[String]
    Definition Classes
    StandardScalaSettings
  293. val target: ChoiceSetting
    Definition Classes
    StandardScalaSettings
  294. def targetValue: String
    Definition Classes
    StandardScalaSettings
  295. val termConflict: ChoiceSetting
    Definition Classes
    ScalaSettings
  296. def toConciseString: String
    Definition Classes
    AbsSettings
  297. def toString(): String
    Definition Classes
    AbsSettings → AnyRef → Any
  298. val unchecked: BooleanSetting
    Definition Classes
    StandardScalaSettings
  299. lazy val uncompilableFiles: collection.immutable.List[File]
  300. val uniqid: BooleanSetting
    Definition Classes
    StandardScalaSettings
  301. def unitSpecialization: Boolean
    Definition Classes
    Warnings
  302. val unsafe: MultiStringSetting
    Definition Classes
    ScalaSettings
  303. val usejavacp: BooleanSetting
    Definition Classes
    StandardScalaSettings
  304. val usemanifestcp: BooleanSetting
    Definition Classes
    StandardScalaSettings
  305. def userSetSettings: List[Setting]
    Definition Classes
    AbsSettings
  306. val verbose: BooleanSetting
    Definition Classes
    StandardScalaSettings
  307. val version: BooleanSetting
    Definition Classes
    StandardScalaSettings
  308. val visibilityPrivate: BooleanSetting
  309. def visibleSettings: List[Setting]
    Definition Classes
    AbsSettings
  310. def warnAdaptedArgs: Boolean
    Definition Classes
    Warnings
  311. def warnByNameImplicit: Boolean
    Definition Classes
    Warnings
  312. def warnCaptured: Boolean
    Definition Classes
    Warnings
  313. def warnCloneableObject: Boolean
    Definition Classes
    Warnings
  314. def warnConstant: Boolean
    Definition Classes
    Warnings
  315. val warnDeadCode: BooleanSetting
    Definition Classes
    Warnings
  316. def warnDelayedInit: Boolean
    Definition Classes
    Warnings
  317. def warnDocDetached: Boolean
    Definition Classes
    Warnings
  318. def warnEtaSam: Boolean
    Definition Classes
    Warnings
  319. def warnEtaZero: Boolean
    Definition Classes
    Warnings
  320. val warnExtraImplicit: BooleanSetting
    Definition Classes
    Warnings
  321. def warnInaccessible: Boolean
    Definition Classes
    Warnings
  322. def warnInferAny: Boolean
    Definition Classes
    Warnings
  323. val warnMacros: ChoiceSetting
    Definition Classes
    Warnings
  324. def warnMissingInterpolator: Boolean
    Definition Classes
    Warnings
  325. val warnMultiargInfix: BooleanSetting
    Definition Classes
    Warnings
  326. val warnNonUnitIf: BooleanSetting
    Definition Classes
    Warnings
  327. val warnNonUnitStatement: settings.Warnings.warnNonUnitStatement._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
    Definition Classes
    Warnings
  328. def warnNonlocalReturn: Boolean
    Definition Classes
    Warnings
  329. def warnNullaryUnit: Boolean
    Definition Classes
    Warnings
  330. val warnNumericWiden: BooleanSetting
    Definition Classes
    Warnings
  331. val warnOctalLiteral: BooleanSetting
    Definition Classes
    Warnings
  332. def warnOptionImplicit: Boolean
    Definition Classes
    Warnings
  333. def warnPackageObjectClasses: Boolean
    Definition Classes
    Warnings
  334. def warnPatternShadow: Boolean
    Definition Classes
    Warnings
  335. val warnPerformance: MultiChoiceSetting[PerformanceWarnings.type]
    Definition Classes
    Warnings
  336. def warnPolyImplicitOverload: Boolean
    Definition Classes
    Warnings
  337. def warnPrivateShadow: Boolean
    Definition Classes
    Warnings
  338. def warnRecurseWithDefault: Boolean
    Definition Classes
    Warnings
  339. def warnSerialization: Boolean
    Definition Classes
    Warnings
  340. def warnStarsAlign: Boolean
    Definition Classes
    Warnings
  341. def warnStrictUnsealedPatMat: Boolean
    Definition Classes
    Warnings
  342. val warnToString: BooleanSetting
    Definition Classes
    Warnings
  343. def warnTypeParameterShadow: Boolean
    Definition Classes
    Warnings
  344. val warnUnnamedBoolean: BooleanSetting
    Definition Classes
    Warnings
  345. val warnUnnamedStrict: settings.Warnings.warnUnnamedStrict._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
    Definition Classes
    Warnings
  346. val warnUnused: MultiChoiceSetting[UnusedWarnings.type]
    Definition Classes
    Warnings
  347. def warnUnusedExplicits: Boolean
    Definition Classes
    Warnings
  348. def warnUnusedImplicits: Boolean
    Definition Classes
    Warnings
  349. def warnUnusedImport: Boolean
    Definition Classes
    Warnings
  350. def warnUnusedLocals: Boolean
    Definition Classes
    Warnings
  351. def warnUnusedNowarn: Boolean
    Definition Classes
    Warnings
  352. def warnUnusedParams: Boolean
    Definition Classes
    Warnings
  353. def warnUnusedPatVars: Boolean
    Definition Classes
    Warnings
  354. def warnUnusedPrivates: Boolean
    Definition Classes
    Warnings
  355. def warnUnusedSynthetics: Boolean
    Definition Classes
    Warnings
  356. val warnValueDiscard: BooleanSetting
    Definition Classes
    Warnings
  357. val warnValueOverrides: BooleanSetting
    Definition Classes
    Warnings
  358. def withErrorFn(errorFn: (String) => Unit): nsc.Settings
    Definition Classes
    SettingsMutableSettings
  359. 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. :)

  360. object CachePolicy
    Definition Classes
    ScalaSettings
  361. object MacroExpand
    Definition Classes
    ScalaSettings
  362. object XxmlSettings extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  363. object languageFeatures extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  364. object mixinForwarderChoices
    Definition Classes
    ScalaSettings
  365. object optChoices extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  366. object optWarningsChoices extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  367. object sourceFeatures extends MultiChoiceEnumeration
    Definition Classes
    ScalaSettings
  368. object LintWarnings extends MultiChoiceEnumeration
    Definition Classes
    Warnings
  369. object PerformanceWarnings extends MultiChoiceEnumeration
    Definition Classes
    Warnings
  370. 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 isScala3: Boolean
    Definition Classes
    ScalaSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.9) Use currentRun.isScala3 instead

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

    (Since version 2.13.3) Use lintImplicitRecursion

  8. val xoptInlineFrom: MultiStringSetting
    Definition Classes
    ScalaSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.8) Deprecated alias

  9. val xoptWarnings: MultiChoiceSetting[optWarningsChoices.type]
    Definition Classes
    ScalaSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.8) Deprecated alias