class Settings extends nsc.Settings
An extended version of compiler settings, with additional Scaladoc-specific options.
- Source
- Settings.scala
- Alphabetic
- By Inheritance
- Settings
- Settings
- MutableSettings
- ScalaSettings
- Warnings
- StandardScalaSettings
- AbsSettings
- MutableSettings
- AbsSettings
- AnyRef
- Any
- by SettingsOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Settings(error: (String) => Unit, printMsg: (String) => Unit)
- 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
- trait AbsSettingValue extends AnyRef
- Definition Classes
- AbsSettings
- type ResultOfTryToSet = collection.immutable.List[String]
- Definition Classes
- MutableSettings → AbsSettings
- trait SettingValue extends reflect.internal.settings.MutableSettings.AbsSettingValue
- Definition Classes
- MutableSettings
- trait AbsSetting extends Ordered[Setting] with AbsSettingValue
- Definition Classes
- AbsSettings
- trait InternalSetting extends AbsSetting
- Definition Classes
- AbsSettings
- 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
- class ChoiceSetting extends Setting
A setting represented by a string in a given set of
choices, (defaultunless set).A setting represented by a string in a given set of
choices, (defaultunless set).- Definition Classes
- MutableSettings
- class EnableSettings[T <: BooleanSetting] extends AnyRef
Internal use - syntax enhancements.
Internal use - syntax enhancements.
- Attributes
- protected
- Definition Classes
- MutableSettings
- class IntSetting extends Setting
A setting represented by an integer.
A setting represented by an integer.
- Definition Classes
- MutableSettings
- 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
Valueconstructor: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
expandsToenable other options. Note that expanding choices are not present in the multiChoiceSetting.value set, only their expansion.- Definition Classes
- MutableSettings
- 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
- 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
- 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
- class OutputSetting extends StringSetting
Set the output directory for all sources.
Set the output directory for all sources.
- Definition Classes
- MutableSettings
- class PathSetting extends StringSetting
- Definition Classes
- MutableSettings
- 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
- 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
- class ScalaVersionSetting extends Setting
A setting represented by a Scala version.
A setting represented by a Scala version. The
initialvalue is used if the setting is not specified. Thedefaultvalue is used if the option is specified without argument (e.g.,-Xmigration).- Definition Classes
- MutableSettings
- 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
valuefield of the appropriate type.- Definition Classes
- MutableSettings
- class StringSetting extends Setting
A setting represented by a string, (
defaultunless set)A setting represented by a string, (
defaultunless set)- Definition Classes
- MutableSettings
- sealed abstract class CachePolicy extends AnyRef
- Definition Classes
- ScalaSettings
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Settings, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def BooleanSetting(name: String, descr: String, default: Boolean = false): BooleanSetting
- Definition Classes
- MutableSettings
- def ChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: String, choicesHelp: List[String] = Nil): ChoiceSetting
- Definition Classes
- MutableSettings
- def IntSetting(name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) => Option[Int]): IntSetting
- Definition Classes
- MutableSettings
- 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
- def MultiStringSetting(name: String, arg: String, descr: String, default: List[String] = Nil, helpText: Option[String] = None, prepend: Boolean = false): MultiStringSetting
- Definition Classes
- MutableSettings
- def OutputSetting(default: String): OutputSetting
- Definition Classes
- MutableSettings
- def PathSetting(name: String, descr: String, default: String): PathSetting
- Definition Classes
- MutableSettings
- def PhasesSetting(name: String, descr: String, default: String = ""): PhasesSetting
- Definition Classes
- MutableSettings
- def PrefixSetting(name: String, prefix: String, descr: String): PrefixSetting
- Definition Classes
- MutableSettings
- def ScalaVersionSetting(name: String, arg: String, descr: String, initial: ScalaVersion, default: Option[ScalaVersion] = None, helpText: Option[String] = None): ScalaVersionSetting
- Definition Classes
- MutableSettings
- def StringSetting(name: String, arg: String, descr: String, default: String = "", helpText: Option[String] = None): StringSetting
- Definition Classes
- MutableSettings
- val VdebugTypeError: BooleanSetting
- Definition Classes
- ScalaSettings
- val Vhelp: BooleanSetting
-V "Verbose" settings
-V "Verbose" settings
- Definition Classes
- ScalaSettings
- val Vimplicits: BooleanSetting
- Definition Classes
- ScalaSettings
- val VimplicitsMaxRefined: IntSetting
- Definition Classes
- ScalaSettings
- val VimplicitsVerboseTree: BooleanSetting
- Definition Classes
- ScalaSettings
- val VtypeDiffs: BooleanSetting
- Definition Classes
- ScalaSettings
- val Wconf: MultiStringSetting
- Definition Classes
- Warnings
- val Whelp: BooleanSetting
- Definition Classes
- Warnings
- val Xexperimental: BooleanSetting
- Definition Classes
- ScalaSettings
- val Xhelp: BooleanSetting
-X "Advanced" settings
-X "Advanced" settings
- Definition Classes
- ScalaSettings
- val Xjline: ChoiceSetting
- Definition Classes
- ScalaSettings
- val XmacroSettings: MultiStringSetting
- Definition Classes
- ScalaSettings
- val Xmigration: ScalaVersionSetting
- Definition Classes
- ScalaSettings
- val XmixinForceForwarders: ChoiceSetting
- Definition Classes
- ScalaSettings
- val XnoPatmatAnalysis: BooleanSetting
- Definition Classes
- ScalaSettings
- val Xnojline: BooleanSetting
- Definition Classes
- ScalaSettings
- val Xprint: PhasesSetting
- Definition Classes
- ScalaSettings
- val Xprintpos: BooleanSetting
- Definition Classes
- ScalaSettings
- val Xshowcls: StringSetting
- Definition Classes
- ScalaSettings
- val Xshowobj: StringSetting
- Definition Classes
- ScalaSettings
- val Xshowtrees: BooleanSetting
- Definition Classes
- ScalaSettings
- val XshowtreesCompact: BooleanSetting
- Definition Classes
- ScalaSettings
- val XshowtreesStringified: BooleanSetting
- Definition Classes
- ScalaSettings
- val XsourceFeatures: MultiChoiceSetting[sourceFeatures.type]
- Definition Classes
- ScalaSettings
- val Xverify: BooleanSetting
- Definition Classes
- ScalaSettings
- val Xxml: MultiChoiceSetting[XxmlSettings.type]
- Definition Classes
- ScalaSettings
- val YaddBackendThreads: IntSetting
- Definition Classes
- ScalaSettings
- val YcacheMacroClassLoader: ChoiceSetting
- Definition Classes
- ScalaSettings
- val YcachePluginClassLoader: ChoiceSetting
- Definition Classes
- ScalaSettings
- val Ycompacttrees: BooleanSetting
- Definition Classes
- ScalaSettings
- val YdebugTasty: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ydelambdafy: ChoiceSetting
- Definition Classes
- ScalaSettings
- val YdisableFlatCpCaching: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ydocdebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ydumpclasses: StringSetting
- Definition Classes
- ScalaSettings
- val YforceFlatCpCaching: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ygenasmp: StringSetting
- Definition Classes
- ScalaSettings
- val Yhelp: BooleanSetting
-Y "Private" settings
-Y "Private" settings
- Definition Classes
- ScalaSettings
- val YhotStatisticsEnabled: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yidedebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val YjarCompressionLevel: IntSetting
- Definition Classes
- ScalaSettings
- val YjarFactory: StringSetting
- Definition Classes
- ScalaSettings
- val Ylogcp: BooleanSetting
- Definition Classes
- ScalaSettings
- val YmacroAnnotations: BooleanSetting
- Definition Classes
- ScalaSettings
- val YmacroClasspath: PathSetting
- Definition Classes
- ScalaSettings
- val YmacroFresh: BooleanSetting
- Definition Classes
- ScalaSettings
- val YmacrodebugLite: BooleanSetting
- Definition Classes
- ScalaSettings
- val YmacrodebugVerbose: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ymacroexpand: ChoiceSetting
- Definition Classes
- ScalaSettings
- val YmaxQueue: IntSetting
- Definition Classes
- ScalaSettings
- val Ymemberpos: StringSetting
- Definition Classes
- ScalaSettings
- val Ynogenericsig: BooleanSetting
- Definition Classes
- ScalaSettings
- val YoptInlineHeuristics: ChoiceSetting
- Definition Classes
- ScalaSettings
- val YoptLogInline: StringSetting
- Definition Classes
- ScalaSettings
- val YoptTrace: StringSetting
- Definition Classes
- ScalaSettings
- val Youtline: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpatmatExhaustdepth: IntSetting
- Definition Classes
- ScalaSettings
- val Ypatmatdebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpickleJava: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpickleWrite: StringSetting
- Definition Classes
- ScalaSettings
- val YpickleWriteApiOnly: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yposdebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpresentationAnyThread: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpresentationDebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpresentationDelay: IntSetting
- Definition Classes
- ScalaSettings
- val YpresentationLocateSourceFile: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpresentationLog: StringSetting
- Definition Classes
- ScalaSettings
- val YpresentationReplay: StringSetting
- Definition Classes
- ScalaSettings
- val YpresentationStrict: BooleanSetting
- Definition Classes
- ScalaSettings
- val YpresentationVerbose: BooleanSetting
IDE-specific settings
IDE-specific settings
- Definition Classes
- ScalaSettings
- val YprintTrees: ChoiceSetting
- Definition Classes
- ScalaSettings
- val YprofileDestination: StringSetting
- Definition Classes
- ScalaSettings
- val YprofileEnabled: BooleanSetting
- Definition Classes
- ScalaSettings
- val YprofileExternalTool: PhasesSetting
- Definition Classes
- ScalaSettings
- val YprofileRunGcBetweenPhases: PhasesSetting
- Definition Classes
- ScalaSettings
- val YprofileTrace: StringSetting
- Definition Classes
- ScalaSettings
- val Yquasiquotedebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yrangepos: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yrecursion: IntSetting
- Definition Classes
- ScalaSettings
- val Yreifycopypaste: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yreifydebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val YreplMagicImport: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yreplclassbased: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yreploutdir: StringSetting
- Definition Classes
- ScalaSettings
- val Yscala3ImplicitResolution: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yscriptrunner: StringSetting
- Definition Classes
- ScalaSettings
- val Yshow: PhasesSetting
- Definition Classes
- ScalaSettings
- val Yshowsymkinds: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yshowsymowners: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yshowsyms: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ystatistics: PhasesSetting
- Definition Classes
- ScalaSettings
- val YstatisticsEnabled: BooleanSetting
- Definition Classes
- ScalaSettings
- val YtastyNoAnnotations: BooleanSetting
- Definition Classes
- ScalaSettings
- val YtastyReader: BooleanSetting
- Definition Classes
- ScalaSettings
- val YtrackDependencies: BooleanSetting
- Definition Classes
- ScalaSettings
- val Ytyperdebug: BooleanSetting
- Definition Classes
- ScalaSettings
- val Yvalidatepos: PhasesSetting
- Definition Classes
- ScalaSettings
- lazy val allSettings: LinkedHashMap[String, Setting]
Set of settings
Set of settings
- Attributes
- protected[scala]
- Definition Classes
- ScalaSettings
- 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()
- 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()
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val async: BooleanSetting
- Definition Classes
- ScalaSettings
- val bootclasspath: PathSetting
Path related settings.
Path related settings.
- Definition Classes
- StandardScalaSettings
- val breakCycles: BooleanSetting
- Definition Classes
- ScalaSettings
- val browse: PhasesSetting
- Definition Classes
- ScalaSettings
- val check: PhasesSetting
- Definition Classes
- ScalaSettings
- def checkDependencies: Boolean
- Definition Classes
- AbsSettings
- val checkInit: BooleanSetting
- Definition Classes
- ScalaSettings
- val classpath: PathSetting
- Definition Classes
- ScalaSettings → StandardScalaSettings
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def conflictWarning: Option[String]
- Definition Classes
- ScalaSettings
- 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
- def copyInto(settings: MutableSettings): Unit
- Definition Classes
- MutableSettings
- val debug: BooleanSetting
- Definition Classes
- ScalaSettings
- 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
- def defaultClasspath: String
The user class path, specified by
-classpathor-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
-classpathor-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
- val defines: PrefixSetting
- Definition Classes
- ScalaSettings
- def dependenciesFile: StringSetting
- Definition Classes
- ScalaSettings
- val dependencyfile: StringSetting
Other settings.
Other settings.
- Definition Classes
- StandardScalaSettings
- val deprecation: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val developer: BooleanSetting
- Definition Classes
- ScalaSettings
- def disable(s: Setting): LinkedHashMap[String, Setting]
Disable a setting
Disable a setting
- Definition Classes
- ScalaSettings
- val disable: MultiStringSetting
- Definition Classes
- ScalaSettings
- val docAuthor: BooleanSetting
- val docCanonicalBaseUrl: StringSetting
- val docDiagrams: BooleanSetting
- val docDiagramsDebug: BooleanSetting
- val docDiagramsDotPath: PathSetting
- val docDiagramsDotRestart: IntSetting
- val docDiagramsDotTimeout: IntSetting
- val docDiagramsMaxImplicitClasses: IntSetting
The maximum number of implicit classes to show in the diagram
- val docDiagramsMaxNormalClasses: IntSetting
The maximum number of normal classes to show in the diagram
- val docExpandAllTypes: BooleanSetting
- val docExternalDoc: MultiStringSetting
- val docGroups: BooleanSetting
- val docImplicits: BooleanSetting
- val docImplicitsDebug: BooleanSetting
- val docImplicitsHide: MultiStringSetting
- val docImplicitsShowAll: BooleanSetting
- val docImplicitsSoundShadowing: BooleanSetting
- val docNoJavaComments: BooleanSetting
- val docNoLinkWarnings: BooleanSetting
- val docNoPrefixes: BooleanSetting
- val docRawOutput: BooleanSetting
- val docRequired: BooleanSetting
- val docRootContent: PathSetting
- val docSkipPackages: StringSetting
- val docUncompilable: StringSetting
- val docfooter: StringSetting
- 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. - val docgenerator: StringSetting
- 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
- val doctitle: StringSetting
A setting that defines the overall title of the documentation, typically the name of the library being documented.
- val docversion: StringSetting
A setting that defines the overall version number of the documentation, typically the version of the library being documented.
- val elidebelow: IntSetting
- Definition Classes
- ScalaSettings
- 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
Tshould provide resourcesapp.class.pathandboot.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
- 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 definingTshould provide resourcesapp.class.pathandboot.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
- val encoding: StringSetting
- Definition Classes
- StandardScalaSettings
- def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
- def ensuring(cond: (Settings) => Boolean): Settings
- def ensuring(cond: Boolean, msg: => Any): Settings
- def ensuring(cond: Boolean): Settings
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- AbsSettings → AnyRef → Any
- val errorFn: (String) => Unit
- Definition Classes
- MutableSettings → AbsSettings
- val explaintypes: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val exposeEmptyPackage: BooleanSetting
- Definition Classes
- ScalaSettings
- lazy val extUrlMapping: Map[String, String]
- val extdirs: PathSetting
- Definition Classes
- StandardScalaSettings
- val fatalWarnings: BooleanSetting
- Definition Classes
- Warnings
- val feature: BooleanSetting
- Definition Classes
- StandardScalaSettings
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val future: BooleanSetting
Groups of Settings.
Groups of Settings.
- Definition Classes
- ScalaSettings
- val g: ChoiceSetting
- Definition Classes
- StandardScalaSettings
- val genPhaseGraph: StringSetting
- Definition Classes
- ScalaSettings
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AbsSettings → AnyRef → Any
- val help: BooleanSetting
- Definition Classes
- StandardScalaSettings
- lazy val hiddenImplicits: Set[String]
- val imports: MultiStringSetting
- Definition Classes
- ScalaSettings
- 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
- def inlineHelp: String
- Definition Classes
- ScalaSettings
- implicit def installEnableSettings[T <: BooleanSetting](s: T): EnableSettings[T]
- Attributes
- protected
- Definition Classes
- MutableSettings
- 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()
- 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()
- def isInfo: Boolean
Is an info setting set? Any -option:help?
Is an info setting set? Any -option:help?
- Definition Classes
- ScalaSettings
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- val isScaladocSpecific: (String) => Boolean
- val javabootclasspath: PathSetting
- Definition Classes
- StandardScalaSettings
- val javaextdirs: PathSetting
- Definition Classes
- StandardScalaSettings
- val jdkApiDocBase: StringSetting
- val jvmargs: PrefixSetting
- Definition Classes
- ScalaSettings
- val language: MultiChoiceSetting[languageFeatures.type]
- Definition Classes
- ScalaSettings
- val lint: MultiChoiceSetting[LintWarnings.type]
- Definition Classes
- Warnings
- def lintArgDiscard: Boolean
- Definition Classes
- Warnings
- def lintDeprecation: Boolean
- Definition Classes
- Warnings
- def lintImplicitNotFound: Boolean
- Definition Classes
- Warnings
- def lintImplicitRecursion: Boolean
- Definition Classes
- Warnings
- def lintIntDivToFloat: Boolean
- Definition Classes
- Warnings
- def lintNumericMethods: Boolean
- Definition Classes
- Warnings
- def lintUniversalMethods: Boolean
- Definition Classes
- Warnings
- def lintUnused: Boolean
- Definition Classes
- Warnings
- def lintValPatterns: Boolean
- Definition Classes
- Warnings
- val log: PhasesSetting
- Definition Classes
- ScalaSettings
- val logFreeTerms: BooleanSetting
- Definition Classes
- ScalaSettings
- val logFreeTypes: BooleanSetting
- Definition Classes
- ScalaSettings
- val logImplicitConv: BooleanSetting
- Definition Classes
- ScalaSettings
- val logReflectiveCalls: BooleanSetting
- Definition Classes
- ScalaSettings
- def lookupSetting(cmd: String): Option[Setting]
- Definition Classes
- AbsSettings
- val mainClass: StringSetting
- Definition Classes
- ScalaSettings
- val maxerrs: IntSetting
- Definition Classes
- ScalaSettings
- val maxwarns: IntSetting
- Definition Classes
- ScalaSettings
- def multiargInfix: Boolean
- Definition Classes
- Warnings
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noCompletion: BooleanSetting
- Definition Classes
- ScalaSettings
- val noForwarders: BooleanSetting
- Definition Classes
- ScalaSettings
- val noassertions: settings.ScalaSettings.noassertions.stabilizer$1.type.s.type forSome {val stabilizer$1: EnableSettings[BooleanSetting]}
- Definition Classes
- ScalaSettings
- val nobootcp: BooleanSetting
- Definition Classes
- ScalaSettings
- val noimports: BooleanSetting
- Definition Classes
- ScalaSettings
- val nonStrictPatmatAnalysis: BooleanSetting
- Definition Classes
- ScalaSettings
- val nopredef: BooleanSetting
- Definition Classes
- ScalaSettings
- val nospecialization: BooleanSetting
- Definition Classes
- ScalaSettings
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val nowarn: BooleanSetting
- Definition Classes
- StandardScalaSettings
- def nowarnings: BooleanSetting
- Definition Classes
- ScalaSettings
- val opt: MultiChoiceSetting[optChoices.type]
- Definition Classes
- ScalaSettings
- def optAddToBytecodeRepository: Boolean
- Definition Classes
- ScalaSettings
- def optAllowSkipClassLoading: Boolean
- Definition Classes
- ScalaSettings
- def optAllowSkipCoreModuleInit: Boolean
- Definition Classes
- ScalaSettings
- def optAssumeModulesNonNull: Boolean
- Definition Classes
- ScalaSettings
- def optBoxUnbox: Boolean
- Definition Classes
- ScalaSettings
- def optBuildCallGraph: Boolean
- Definition Classes
- ScalaSettings
- def optClosureInvocations: Boolean
- Definition Classes
- ScalaSettings
- def optCompactLocals: Boolean
- Definition Classes
- ScalaSettings
- def optCopyPropagation: Boolean
- Definition Classes
- ScalaSettings
- def optInlineFrom: List[String]
- Definition Classes
- ScalaSettings
- def optInlinerEnabled: Boolean
- Definition Classes
- ScalaSettings
- def optNone: Boolean
- Definition Classes
- ScalaSettings
- def optNullnessTracking: Boolean
- Definition Classes
- ScalaSettings
- def optRedundantCasts: Boolean
- Definition Classes
- ScalaSettings
- def optSimplifyJumps: Boolean
- Definition Classes
- ScalaSettings
- def optUnreachableCode: Boolean
- Definition Classes
- ScalaSettings
- def optUseAnalyzerCache: Boolean
- Definition Classes
- ScalaSettings
- def optWarningEmitAtInlineFailed: Boolean
- Definition Classes
- ScalaSettings
- def optWarningNoInlineMissingBytecode: Boolean
- Definition Classes
- ScalaSettings
- def optWarningNoInlineMissingScalaInlineInfoAttr: Boolean
- Definition Classes
- ScalaSettings
- def optWarningNoInlineMixed: Boolean
- Definition Classes
- ScalaSettings
- val optWarnings: MultiChoiceSetting[optWarningsChoices.type]
- Definition Classes
- ScalaSettings
- def optWarningsSummaryOnly: Boolean
- Definition Classes
- ScalaSettings
- val optimise: BooleanSetting
- Definition Classes
- ScalaSettings → StandardScalaSettings
- val outdir: OutputSetting
- Definition Classes
- ScalaSettings
- 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
-dcommandline option sets a single directory for all sources.- Definition Classes
- MutableSettings
- def parseParams(args: List[String]): List[String]
Returns any unprocessed arguments.
Returns any unprocessed arguments.
- Attributes
- protected
- Definition Classes
- MutableSettings
- val pathFactory: PathFactory
- Definition Classes
- MutableSettings
- val plugin: MultiStringSetting
- Definition Classes
- ScalaSettings
- val pluginOptions: MultiStringSetting
-P "Plugin" settings
-P "Plugin" settings
- Definition Classes
- ScalaSettings
- val pluginsDir: StringSetting
- Definition Classes
- ScalaSettings
- 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
- val print: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val printArgs: StringSetting
- Definition Classes
- ScalaSettings
- def printLate: BooleanSetting
- Definition Classes
- ScalaSettings
- val printMsg: (String) => Unit
- val printtypes: BooleanSetting
- Definition Classes
- ScalaSettings
- def processArgumentString(params: String): (Boolean, List[String])
- Definition Classes
- MutableSettings
- 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
- val prompt: BooleanSetting
- Definition Classes
- ScalaSettings
- def quickFixSilent: Boolean
- Definition Classes
- StandardScalaSettings
- val quickfix: MultiStringSetting
- Definition Classes
- StandardScalaSettings
- def recreateArgs: List[String]
- Definition Classes
- AbsSettings
- val release: ChoiceSetting
- Definition Classes
- StandardScalaSettings
- def releaseValue: Option[String]
- Definition Classes
- StandardScalaSettings
- val reporter: StringSetting
- Definition Classes
- ScalaSettings
- val require: MultiStringSetting
- Definition Classes
- ScalaSettings
- val resident: BooleanSetting
- Definition Classes
- ScalaSettings
- val rootdir: PathSetting
- Definition Classes
- StandardScalaSettings
- def scalaDocSpecific: Set[Setting]
- var scaladocQuietRun: Boolean
- val script: StringSetting
- Definition Classes
- ScalaSettings
- val showPhases: BooleanSetting
- Definition Classes
- ScalaSettings
- val showPlugins: BooleanSetting
- Definition Classes
- ScalaSettings
- def showTreeDiff: Boolean
- Definition Classes
- ScalaSettings
- val skip: PhasesSetting
- Definition Classes
- ScalaSettings
- def skipPackage(qname: String): Boolean
- lazy val skipPackageNames: Set[String]
- val source: ScalaVersionSetting
- Definition Classes
- ScalaSettings
- Annotations
- @nowarn()
- val sourceReader: StringSetting
- Definition Classes
- ScalaSettings
- val sourcepath: PathSetting
- Definition Classes
- StandardScalaSettings
- def splitParams(line: String): List[String]
Split the given line into parameters.
Split the given line into parameters.
- Definition Classes
- MutableSettings
- val stopAfter: PhasesSetting
- Definition Classes
- ScalaSettings
- val stopBefore: PhasesSetting
- Definition Classes
- ScalaSettings
- def stripIndex(url: String): String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val target: ChoiceSetting
- Definition Classes
- StandardScalaSettings
- def targetValue: String
- Definition Classes
- StandardScalaSettings
- val termConflict: ChoiceSetting
- Definition Classes
- ScalaSettings
- def toConciseString: String
- Definition Classes
- AbsSettings
- def toString(): String
- Definition Classes
- AbsSettings → AnyRef → Any
- val unchecked: BooleanSetting
- Definition Classes
- StandardScalaSettings
- lazy val uncompilableFiles: collection.immutable.List[File]
- val uniqid: BooleanSetting
- Definition Classes
- StandardScalaSettings
- def unitSpecialization: Boolean
- Definition Classes
- Warnings
- val unsafe: MultiStringSetting
- Definition Classes
- ScalaSettings
- val usejavacp: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val usemanifestcp: BooleanSetting
- Definition Classes
- StandardScalaSettings
- def userSetSettings: List[Setting]
- Definition Classes
- AbsSettings
- val verbose: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val version: BooleanSetting
- Definition Classes
- StandardScalaSettings
- val visibilityPrivate: BooleanSetting
- def visibleSettings: List[Setting]
- Definition Classes
- AbsSettings
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def warnAdaptedArgs: Boolean
- Definition Classes
- Warnings
- def warnByNameImplicit: Boolean
- Definition Classes
- Warnings
- def warnCaptured: Boolean
- Definition Classes
- Warnings
- def warnCloneableObject: Boolean
- Definition Classes
- Warnings
- def warnConstant: Boolean
- Definition Classes
- Warnings
- val warnDeadCode: BooleanSetting
- Definition Classes
- Warnings
- def warnDelayedInit: Boolean
- Definition Classes
- Warnings
- def warnDocDetached: Boolean
- Definition Classes
- Warnings
- def warnEtaSam: Boolean
- Definition Classes
- Warnings
- def warnEtaZero: Boolean
- Definition Classes
- Warnings
- val warnExtraImplicit: BooleanSetting
- Definition Classes
- Warnings
- def warnInaccessible: Boolean
- Definition Classes
- Warnings
- def warnInferAny: Boolean
- Definition Classes
- Warnings
- val warnMacros: ChoiceSetting
- Definition Classes
- Warnings
- def warnMissingInterpolator: Boolean
- Definition Classes
- Warnings
- val warnNonUnitIf: BooleanSetting
- Definition Classes
- Warnings
- val warnNonUnitStatement: settings.Warnings.warnNonUnitStatement._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
- Definition Classes
- Warnings
- def warnNonlocalReturn: Boolean
- Definition Classes
- Warnings
- def warnNullaryUnit: Boolean
- Definition Classes
- Warnings
- val warnNumericWiden: BooleanSetting
- Definition Classes
- Warnings
- val warnOctalLiteral: BooleanSetting
- Definition Classes
- Warnings
- def warnOptionImplicit: Boolean
- Definition Classes
- Warnings
- def warnPackageObjectClasses: Boolean
- Definition Classes
- Warnings
- def warnPatternShadow: Boolean
- Definition Classes
- Warnings
- val warnPerformance: MultiChoiceSetting[PerformanceWarnings.type]
- Definition Classes
- Warnings
- def warnPolyImplicitOverload: Boolean
- Definition Classes
- Warnings
- def warnPrivateShadow: Boolean
- Definition Classes
- Warnings
- def warnRecurseWithDefault: Boolean
- Definition Classes
- Warnings
- def warnSerialization: Boolean
- Definition Classes
- Warnings
- def warnStarsAlign: Boolean
- Definition Classes
- Warnings
- def warnStrictUnsealedPatMat: Boolean
- Definition Classes
- Warnings
- def warnTypeParameterShadow: Boolean
- Definition Classes
- Warnings
- val warnUnnamedBoolean: BooleanSetting
- Definition Classes
- Warnings
- val warnUnnamedStrict: settings.Warnings.warnUnnamedStrict._1.type.s.type forSome {val _1: EnableSettings[BooleanSetting]}
- Definition Classes
- Warnings
- val warnUnused: MultiChoiceSetting[UnusedWarnings.type]
- Definition Classes
- Warnings
- def warnUnusedExplicits: Boolean
- Definition Classes
- Warnings
- def warnUnusedImplicits: Boolean
- Definition Classes
- Warnings
- def warnUnusedImport: Boolean
- Definition Classes
- Warnings
- def warnUnusedLocals: Boolean
- Definition Classes
- Warnings
- def warnUnusedNowarn: Boolean
- Definition Classes
- Warnings
- def warnUnusedParams: Boolean
- Definition Classes
- Warnings
- def warnUnusedPatVars: Boolean
- Definition Classes
- Warnings
- def warnUnusedPrivates: Boolean
- Definition Classes
- Warnings
- def warnUnusedSynthetics: Boolean
- Definition Classes
- Warnings
- val warnValueDiscard: BooleanSetting
- Definition Classes
- Warnings
- val warnValueOverrides: BooleanSetting
- Definition Classes
- Warnings
- def withErrorFn(errorFn: (String) => Unit): nsc.Settings
- Definition Classes
- Settings → MutableSettings
- 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. :)
- object CachePolicy
- Definition Classes
- ScalaSettings
- object MacroExpand
- Definition Classes
- ScalaSettings
- object XxmlSettings extends MultiChoiceEnumeration
- Definition Classes
- ScalaSettings
- object languageFeatures extends MultiChoiceEnumeration
- Definition Classes
- ScalaSettings
- object mixinForwarderChoices
- Definition Classes
- ScalaSettings
- object optChoices extends MultiChoiceEnumeration
- Definition Classes
- ScalaSettings
- object optWarningsChoices extends MultiChoiceEnumeration
- Definition Classes
- ScalaSettings
- object sourceFeatures extends MultiChoiceEnumeration
- Definition Classes
- ScalaSettings
- object LintWarnings extends MultiChoiceEnumeration
- Definition Classes
- Warnings
- object PerformanceWarnings extends MultiChoiceEnumeration
- Definition Classes
- Warnings
- object UnusedWarnings extends MultiChoiceEnumeration
- Definition Classes
- Warnings
Deprecated Value Members
- def Xchecknull: BooleanSetting
- Definition Classes
- Warnings
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) This option is being removed
- def Xwarnfatal: BooleanSetting
- Definition Classes
- Warnings
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) Use fatalWarnings
- val Yreplsync: BooleanSetting
- Definition Classes
- ScalaSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13) Unused setting will be removed
- def Ywarndeadcode: BooleanSetting
- Definition Classes
- Warnings
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) Use warnDeadCode
- def d: OutputSetting
- Definition Classes
- ScalaSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.2) Use outdir instead.
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def isScala3: Boolean
- Definition Classes
- ScalaSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.9) Use currentRun.isScala3 instead
- val warnSelfImplicit: BooleanSetting
- Definition Classes
- Warnings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.3) Use lintImplicitRecursion
- val xoptInlineFrom: MultiStringSetting
- Definition Classes
- ScalaSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.8) Deprecated alias
- val xoptWarnings: MultiChoiceSetting[optWarningsChoices.type]
- Definition Classes
- ScalaSettings
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.8) Deprecated alias
- 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.
The Scala compiler and reflection APIs.