summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/Settings.scala
diff options
context:
space:
mode:
authorGeoffrey Washburn <geoffrey.washburn@epfl.ch>2008-03-05 15:07:14 +0000
committerGeoffrey Washburn <geoffrey.washburn@epfl.ch>2008-03-05 15:07:14 +0000
commit1fcc24dd92a885b44e242d57764105c871979fe7 (patch)
treeca94c292242b116288d16921dec319f50c96b445 /src/compiler/scala/tools/nsc/doc/Settings.scala
parent3b8407a9ae6ab9c888e4458c1ef443b533341fd2 (diff)
downloadscala-1fcc24dd92a885b44e242d57764105c871979fe7.tar.gz
scala-1fcc24dd92a885b44e242d57764105c871979fe7.tar.bz2
scala-1fcc24dd92a885b44e242d57764105c871979fe7.zip
ScalaDoc, etc.
of Settings. All doc related settings have been commented out of Settings (soon to be removed) and are now found in doc.Settings. -Ydoc is no more. I believe I have updated the scaladoc Ant task correctly, but it is not clear how to test it.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/Settings.scala')
-rw-r--r--src/compiler/scala/tools/nsc/doc/Settings.scala28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/Settings.scala b/src/compiler/scala/tools/nsc/doc/Settings.scala
new file mode 100644
index 0000000000..e938f4f36c
--- /dev/null
+++ b/src/compiler/scala/tools/nsc/doc/Settings.scala
@@ -0,0 +1,28 @@
+/* NSC -- new Scala compiler
+ * Copyright 2005-2007 LAMP/EPFL
+ * @author Martin Odersky
+ */
+// $Id$
+
+package scala.tools.nsc.doc
+
+import java.io.File
+import java.lang.System
+
+class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) {
+
+ /** scaladoc specific options */
+ val memberaccess = ChoiceSetting ("-access", "Show only public, protected/public (default) or all classes and members",
+ List("public", "protected", "private"), "protected")
+ val pagebottom = StringSetting ("-bottom", "pagebottom", "Include bottom text for each page", "")
+ val doccharset = StringSetting ("-charset", "doccharset", "Charset for cross-platform viewing of generated documentation.", "")
+ val doctitle = StringSetting ("-doctitle", "doctitle", "Include title for the overview page", "Scala 2<br/>API Specification")
+ val pagefooter = StringSetting ("-footer", "pagefooter", "Include footer text for each page", "")
+ val pageheader = StringSetting ("-header", "pageheader", "Include header text for each page", "")
+ val linksource = BooleanSetting ("-linksource", "Generate source in HTML").hideToIDE
+ val nocomment = BooleanSetting ("-nocomment", "Suppress description and tags, generate only declarations.").hideToIDE
+ val stylesheetfile = StringSetting ("-stylesheetfile", "stylesheetfile", "File to change style of the generated documentation", "style.css")
+ val pagetop = StringSetting ("-top", "pagetop", "Include top text for each page", "")
+ val windowtitle = StringSetting ("-windowtitle", "windowtitle", "Specify window title of generated HTML documentation", "Scala 2")
+
+}