scala.tools.nsc.doc

Settings

class Settings extends 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. Hide All
  2. Show all
  1. Settings
  2. Settings
  3. MutableSettings
  4. Mutable
  5. ScalaSettings
  6. Warnings
  7. StandardScalaSettings
  8. AbsScalaSettings
  9. AbsSettings
  10. AnyRef
  11. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Settings (error: (String) ⇒ Unit)

    error

    A function that prints a string to the appropriate error stream.

Type Members

  1. trait AbsSetting extends Ordered[Setting] with AbsSettingValue

  2. trait AbsSettingValue extends AnyRef

  3. class BooleanSetting extends Setting

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

  4. class ChoiceSetting extends Setting

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

  5. class IntSetting extends Setting

    A setting represented by an integer

  6. trait InternalSetting extends AbsSetting

  7. class MultiStringSetting extends Setting

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

  8. class OutputDirs extends AnyRef

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

  9. class OutputSetting extends StringSetting

    Set the output directory.

  10. class PathSetting extends StringSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  11. class PhasesSetting extends Setting

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

  12. class PrefixSetting extends Setting

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

  13. type ResultOfTryToSet = List[String]

    Definition Classes
    MutableSettingsAbsSettings
  14. class Setting extends AbsSetting with SettingValue with Mutable

    A base class for settings of all types.

  15. class SettingGroup extends AbsSetting

    *

  16. trait SettingValue extends AbsSettingValue

  17. class StringSetting extends Setting

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

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def BooleanSetting (name: String, descr: String): BooleanSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  7. def ChoiceSetting (name: String, helpArg: String, descr: String, choices: List[String], default: String): ChoiceSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  8. def IntSetting (name: String, descr: String, default: Int, range: Option[(Int, Int)], parser: (String) ⇒ Option[Int]): IntSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  9. def MultiStringSetting (name: String, arg: String, descr: String): MultiStringSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  10. def OutputSetting (outputDirs: OutputDirs, default: String): OutputSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  11. def PathSetting (name: String, descr: String, default: String): PathSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  12. def PhasesSetting (name: String, descr: String): PhasesSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  13. def PrefixSetting (name: String, prefix: String, descr: String): PrefixSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  14. implicit lazy val SettingOrdering : Ordering[Setting]

    Attributes
    implicit
    Definition Classes
    AbsSettings
  15. def StringSetting (name: String, arg: String, descr: String, default: String): StringSetting

    Definition Classes
    MutableSettingsAbsScalaSettings
  16. def XO : BooleanSetting

    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
  17. def Xchecknull : BooleanSetting

    Definition Classes
    Warnings
  18. val Xcloselim : BooleanSetting

    Definition Classes
    ScalaSettings
  19. val Xdce : BooleanSetting

    Definition Classes
    ScalaSettings
  20. val Xexperimental : BooleanSetting

    Definition Classes
    ScalaSettings
  21. val Xhelp : BooleanSetting

    -X "Advanced" settings

    -X "Advanced" settings

    Definition Classes
    ScalaSettings
  22. val Xlinearizer : ChoiceSetting

    Definition Classes
    ScalaSettings
  23. val XlogImplicits : BooleanSetting

    Definition Classes
    ScalaSettings
  24. val Xmigration28 : BooleanSetting

    Definition Classes
    ScalaSettings
  25. val Xnojline : BooleanSetting

    Definition Classes
    ScalaSettings
  26. val Xprint : PhasesSetting

    Definition Classes
    ScalaSettings
  27. val Xprintpos : BooleanSetting

    Definition Classes
    ScalaSettings
  28. val Xshowcls : StringSetting

    Definition Classes
    ScalaSettings
  29. val Xshowobj : StringSetting

    Definition Classes
    ScalaSettings
  30. val Xshowtrees : BooleanSetting

    Definition Classes
    ScalaSettings
  31. val Xverify : BooleanSetting

    Definition Classes
    ScalaSettings
  32. def Xwarnfatal : BooleanSetting

    Definition Classes
    Warnings
  33. val Ybuilderdebug : ChoiceSetting

    Definition Classes
    ScalaSettings
  34. val Ybuildmanagerdebug : BooleanSetting

    Definition Classes
    ScalaSettings
  35. val Ycompacttrees : BooleanSetting

    Definition Classes
    ScalaSettings
  36. val Ycompletion : BooleanSetting

    Definition Classes
    ScalaSettings
  37. val YdepMethTpes : BooleanSetting

    Definition Classes
    ScalaSettings
  38. val Ydocdebug : BooleanSetting

    Definition Classes
    ScalaSettings
  39. val Ygenjavap : StringSetting

    Definition Classes
    ScalaSettings
  40. val Yhelp : BooleanSetting

    -Y "Private" settings

    -Y "Private" settings

    Definition Classes
    ScalaSettings
  41. val Yidedebug : BooleanSetting

    Definition Classes
    ScalaSettings
  42. val Yinferdebug : BooleanSetting

    Definition Classes
    ScalaSettings
  43. val Ylogcp : BooleanSetting

    Definition Classes
    ScalaSettings
  44. val YmethodInfer : BooleanSetting

    Definition Classes
    ScalaSettings
  45. val Ynogenericsig : BooleanSetting

    Definition Classes
    ScalaSettings
  46. val Ynosqueeze : BooleanSetting

    Definition Classes
    ScalaSettings
  47. val Ynotnull : BooleanSetting

    Definition Classes
    ScalaSettings
  48. val Ypmatdebug : BooleanSetting

    Definition Classes
    ScalaSettings
  49. val Ypmatnaive : BooleanSetting

    Definition Classes
    ScalaSettings
  50. val YpresentationDebug : BooleanSetting

    Definition Classes
    ScalaSettings
  51. val YpresentationDelay : IntSetting

    Definition Classes
    ScalaSettings
  52. val YpresentationLog : StringSetting

    Definition Classes
    ScalaSettings
  53. val YpresentationReplay : StringSetting

    Definition Classes
    ScalaSettings
  54. val YpresentationVerbose : BooleanSetting

    IDE-specific settings

    IDE-specific settings

    Definition Classes
    ScalaSettings
  55. val Yprofile : PhasesSetting

    Definition Classes
    ScalaSettings
  56. val YprofileClass : StringSetting

    Definition Classes
    ScalaSettings
  57. val YprofileMem : BooleanSetting

    Definition Classes
    ScalaSettings
  58. val Yrangepos : BooleanSetting

    Definition Classes
    ScalaSettings
  59. val Yrecursion : IntSetting

    Definition Classes
    ScalaSettings
  60. val Yrepldebug : BooleanSetting

    Definition Classes
    ScalaSettings
  61. val Yreplsync : BooleanSetting

    Definition Classes
    ScalaSettings
  62. val YrichExes : BooleanSetting

    Definition Classes
    ScalaSettings
  63. val Yshow : PhasesSetting

    Definition Classes
    ScalaSettings
  64. val Yshowsyms : BooleanSetting

    Definition Classes
    ScalaSettings
  65. val Ystatistics : BooleanSetting

    Definition Classes
    ScalaSettings
  66. val Ytyperdebug : BooleanSetting

    Definition Classes
    ScalaSettings
  67. val YvirtClasses : Boolean

    Definition Classes
    ScalaSettings
  68. def Ywarndeadcode : BooleanSetting

    Definition Classes
    Warnings
  69. lazy val allSettings : HashSet[Setting]

    Set of settings

    Set of settings

    Attributes
    protected
    Definition Classes
    ScalaSettings
  70. def allWarnings : List[BooleanSetting]

    Attributes
    protected
    Definition Classes
    Warnings
  71. val argfiles : BooleanSetting

    Standard settings

    Standard settings

    Definition Classes
    ScalaSettingsStandardScalaSettings
  72. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  73. val assemextdirs : StringSetting

    Definition Classes
    ScalaSettings
  74. val assemname : StringSetting

    Definition Classes
    ScalaSettings
  75. val assemrefs : StringSetting

    Definition Classes
    ScalaSettings
  76. val bootclasspath : PathSetting

    Path related settings.

    Path related settings.

    Definition Classes
    StandardScalaSettings
  77. val browse : PhasesSetting

    Definition Classes
    ScalaSettings
  78. val check : PhasesSetting

    Definition Classes
    ScalaSettings
  79. def checkDependencies : Boolean

    Definition Classes
    AbsSettings
  80. val checkInit : BooleanSetting

    Definition Classes
    ScalaSettings
  81. val classpath : PathSetting

    Definition Classes
    ScalaSettingsStandardScalaSettings
  82. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  83. def copy (): Settings

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

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

    Definition Classes
    MutableSettings
  84. val d : OutputSetting

    Definition Classes
    ScalaSettingsStandardScalaSettings
  85. val debug : BooleanSetting

    Definition Classes
    ScalaSettings
  86. def debuginfo : ChoiceSetting

    Definition Classes
    ScalaSettings
  87. val defines : PrefixSetting

    Definition Classes
    ScalaSettings
  88. def dependenciesFile : StringSetting

    Definition Classes
    ScalaSettings
  89. val dependencyfile : StringSetting

    Other settings.

    Other settings.

    Definition Classes
    StandardScalaSettings
  90. val deprecation : BooleanSetting

    Definition Classes
    StandardScalaSettings
  91. def disable (s: Setting): HashSet[Setting]

    Disable a setting

    Disable a setting

    Definition Classes
    ScalaSettings
  92. val disable : MultiStringSetting

    Definition Classes
    ScalaSettings
  93. val docUncompilable : StringSetting

  94. 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.

  95. val docgenerator : StringSetting

  96. 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

  97. val doctitle : StringSetting

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

    A setting that defines the overall title of the documentation, typically the name of the library being documented. Note: This setting is currently not used.

  98. val docversion : StringSetting

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

    A setting that defines the overall version number of the documentation, typically the version of the library being documented. Note: This setting is currently not used.

  99. val elidebelow : IntSetting

    Definition Classes
    ScalaSettings
  100. 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
  101. def embeddedDefaults [T] (implicit arg0: Manifest[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
  102. val encoding : StringSetting

    Definition Classes
    StandardScalaSettings
  103. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  104. def equals (that: Any): Boolean

    Definition Classes
    AbsSettings → AnyRef → Any
  105. val errorFn : (String) ⇒ Unit

    Definition Classes
    MutableSettingsAbsSettings
  106. val explaintypes : BooleanSetting

    Definition Classes
    StandardScalaSettings
  107. val exposeEmptyPackage : BooleanSetting

    Definition Classes
    ScalaSettings
  108. val extdirs : PathSetting

    Definition Classes
    StandardScalaSettings
  109. val fatalWarnings : BooleanSetting

    Definition Classes
    Warnings
  110. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  111. val future : BooleanSetting

    Definition Classes
    ScalaSettings
  112. val g : ChoiceSetting

    Definition Classes
    StandardScalaSettings
  113. val genPhaseGraph : StringSetting

    Definition Classes
    ScalaSettings
  114. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  115. def hashCode (): Int

    Definition Classes
    AbsSettings → AnyRef → Any
  116. val help : BooleanSetting

    Definition Classes
    StandardScalaSettings
  117. val inline : BooleanSetting

    Definition Classes
    ScalaSettings
  118. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  119. val isScaladocSpecific : (String) ⇒ Boolean

  120. val javabootclasspath : PathSetting

    Definition Classes
    StandardScalaSettings
  121. val javaextdirs : PathSetting

    Definition Classes
    StandardScalaSettings
  122. val jvmargs : PrefixSetting

    Definition Classes
    ScalaSettings
  123. val lint : BooleanSetting

    Definition Classes
    Warnings
  124. def lintWarnings : List[BooleanSetting]

    Attributes
    protected
    Definition Classes
    Warnings
  125. val log : PhasesSetting

    Definition Classes
    ScalaSettings
  126. def lookupSetting (cmd: String): Option[Setting]

    Definition Classes
    AbsSettings
  127. val make : ChoiceSetting

    Definition Classes
    StandardScalaSettings
  128. val maxClassfileName : IntSetting

    Definition Classes
    ScalaSettings
  129. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  130. val noCompletion : BooleanSetting

    Definition Classes
    ScalaSettings
  131. val noForwarders : BooleanSetting

    Definition Classes
    ScalaSettings
  132. val noSelfCheck : BooleanSetting

    Definition Classes
    ScalaSettings
  133. val noassertions : BooleanSetting

    Definition Classes
    ScalaSettings
  134. val nobootcp : BooleanSetting

    Definition Classes
    ScalaSettings
  135. val noimports : BooleanSetting

    Definition Classes
    ScalaSettings
  136. val nospecialization : BooleanSetting

    Definition Classes
    ScalaSettings
  137. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  138. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  139. val nouescape : BooleanSetting

    Definition Classes
    ScalaSettings
  140. val nowarn : BooleanSetting

    Definition Classes
    StandardScalaSettings
  141. def nowarnings : BooleanSetting

    Definition Classes
    ScalaSettings
  142. val optimise : BooleanSetting

    Definition Classes
    ScalaSettingsStandardScalaSettings
  143. def outdir : OutputSetting

    Definition Classes
    ScalaSettings
  144. lazy val outputDirs : OutputDirs

    A list pairing source directories with their output directory.

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

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

    Returns any unprocessed arguments.

    Returns any unprocessed arguments.

    Attributes
    protected
    Definition Classes
    MutableSettings
  146. val plugin : MultiStringSetting

    Definition Classes
    ScalaSettings
  147. val pluginOptions : MultiStringSetting

    -P "Plugin" settings

    -P "Plugin" settings

    Definition Classes
    ScalaSettings
  148. val pluginsDir : StringSetting

    Definition Classes
    ScalaSettings
  149. lazy val prefixSettings : HashSet[PrefixSetting]

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

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

    Definition Classes
    MutableSettings
  150. val print : BooleanSetting

    Definition Classes
    StandardScalaSettings
  151. def printLate : BooleanSetting

    Definition Classes
    ScalaSettings
  152. val printtypes : BooleanSetting

    Definition Classes
    ScalaSettings
  153. def processArgumentString (params: String): (Boolean, List[String])

    Definition Classes
    MutableSettings
  154. 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
  155. val prompt : BooleanSetting

    Definition Classes
    ScalaSettings
  156. def recreateArgs : List[String]

    Definition Classes
    AbsSettings
  157. val refinementMethodDispatch : ChoiceSetting

    Definition Classes
    ScalaSettings
  158. val require : MultiStringSetting

    Definition Classes
    ScalaSettings
  159. val resident : BooleanSetting

    Definition Classes
    ScalaSettings
  160. def scaladocSpecific : Set[Setting]

  161. val script : StringSetting

    Definition Classes
    ScalaSettings
  162. val selfInAnnots : BooleanSetting

    Definition Classes
    ScalaSettings
  163. val showPhases : BooleanSetting

    Definition Classes
    ScalaSettings
  164. val showPlugins : BooleanSetting

    Definition Classes
    ScalaSettings
  165. val skip : PhasesSetting

    Definition Classes
    ScalaSettings
  166. val sourceReader : StringSetting

    Definition Classes
    ScalaSettings
  167. val sourcedir : StringSetting

    Definition Classes
    ScalaSettings
  168. val sourcepath : PathSetting

    Definition Classes
    StandardScalaSettings
  169. def splitParams (line: String): List[String]

    Split the given line into parameters.

    Split the given line into parameters.

    Definition Classes
    MutableSettings
  170. def stop : PhasesSetting

    Definition Classes
    ScalaSettings
  171. val stopAfter : PhasesSetting

    Definition Classes
    ScalaSettings
  172. val stopBefore : PhasesSetting

    Definition Classes
    ScalaSettings
  173. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  174. val target : ChoiceSetting

    Definition Classes
    StandardScalaSettings
  175. val termConflict : ChoiceSetting

    Definition Classes
    ScalaSettings
  176. def toConciseString : String

    Definition Classes
    AbsSettings
  177. def toString (): String

    Definition Classes
    AbsSettings → AnyRef → Any
  178. val toolcp : PathSetting

    Definition Classes
    ScalaSettings
  179. val unchecked : BooleanSetting

    Definition Classes
    StandardScalaSettings
  180. lazy val uncompilableFiles : List[File]

  181. val uniqid : BooleanSetting

    Definition Classes
    StandardScalaSettings
  182. val useStupidTypes : BooleanSetting

  183. val usejavacp : BooleanSetting

    Definition Classes
    StandardScalaSettings
  184. def userSetSettings : Set[Setting]

    Definition Classes
    AbsSettings
  185. val verbose : BooleanSetting

    Definition Classes
    StandardScalaSettings
  186. val version : BooleanSetting

    Definition Classes
    StandardScalaSettings
  187. def visibleSettings : Set[Setting]

    Definition Classes
    AbsSettings
  188. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  189. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  190. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  191. val warnDeadCode : BooleanSetting

    Definition Classes
    Warnings
  192. val warnEverything : BooleanSetting

    Definition Classes
    Warnings
  193. val warnInaccessible : BooleanSetting

    Definition Classes
    Warnings
  194. val warnNullaryOverride : BooleanSetting

    Definition Classes
    Warnings
  195. val warnNullaryUnit : BooleanSetting

    Definition Classes
    Warnings
  196. val warnNumericWiden : BooleanSetting

    Definition Classes
    Warnings
  197. val warnSelectNullable : BooleanSetting

    Definition Classes
    Warnings
  198. val warnValueDiscard : BooleanSetting

    Definition Classes
    Warnings
  199. val writeICode : BooleanSetting

    Definition Classes
    ScalaSettings

Inherited from Settings

Inherited from MutableSettings

Inherited from Mutable

Inherited from ScalaSettings

Inherited from Warnings

Inherited from StandardScalaSettings

Inherited from AbsScalaSettings

Inherited from AbsSettings

Inherited from AnyRef

Inherited from Any