summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/Settings.scala
diff options
context:
space:
mode:
authorPaul Phillips <paulp@improving.org>2010-12-05 19:42:17 +0000
committerPaul Phillips <paulp@improving.org>2010-12-05 19:42:17 +0000
commited5459550ef6fd8ed1c23cbe6cec8ba8a541c1e3 (patch)
treece6a4a005aa5619c201aa63a75fdb2b98781d1b0 /src/compiler/scala/tools/nsc/doc/Settings.scala
parent77eb8fefec3e62ead95c7d409ec5a28f30289ec3 (diff)
downloadscala-ed5459550ef6fd8ed1c23cbe6cec8ba8a541c1e3.tar.gz
scala-ed5459550ef6fd8ed1c23cbe6cec8ba8a541c1e3.tar.bz2
scala-ed5459550ef6fd8ed1c23cbe6cec8ba8a541c1e3.zip
Cleaned up and brought up to date the help text...
Cleaned up and brought up to date the help text for -X and -Y options. Made some enhancements to PhasesSetting, which are documented if you run scalac -X or -Y. (Try it!) Disabled some dead settings and renamed others to reflect their current purpose. No review.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/Settings.scala')
-rw-r--r--src/compiler/scala/tools/nsc/doc/Settings.scala8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/Settings.scala b/src/compiler/scala/tools/nsc/doc/Settings.scala
index e567602fae..d4ae1ba42f 100644
--- a/src/compiler/scala/tools/nsc/doc/Settings.scala
+++ b/src/compiler/scala/tools/nsc/doc/Settings.scala
@@ -15,7 +15,7 @@ class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) {
/** A setting that defines in which format the documentation is output. ''Note:'' this setting is currently always
* `html`. */
- val docformat = ChoiceSetting ("-doc-format", "Selects in which format documentation is rendered", List("html"), "html")
+ val docformat = ChoiceSetting ("-doc-format", "format", "Selects in which format documentation is rendered", List("html"), "html")
/** 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. */
@@ -31,8 +31,10 @@ class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) {
val useStupidTypes = BooleanSetting ("-Yuse-stupid-types", "Print the types of inherited members as seen from their original definition context. Hint: you don't want to do that!")
- // working around issue described in r18708.
- suppressVTWarn.value = true
+ // Somewhere slightly before r18708 scaladoc stopped building unless the
+ // self-type check was suppressed. I hijacked the slotted-for-removal-anyway
+ // suppress-vt-warnings option and renamed it for this purpose.
+ noSelfCheck.value = true
// TODO: add a new setting for whether or not to document sourceless entities (e.g., Any, Unit, etc)
}