summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/Settings.scala
diff options
context:
space:
mode:
authorHeather Miller <heather.miller@epfl.ch>2011-09-07 05:18:37 +0000
committerHeather Miller <heather.miller@epfl.ch>2011-09-07 05:18:37 +0000
commitac9243fb9e48dd3a4829cc3bf1caf7241d40b8af (patch)
treebd25f8e7a29421aa05e9eb33ea433b29edea7d12 /src/compiler/scala/tools/nsc/doc/Settings.scala
parentf3114ec2a48e1a48f53bd5065009156b2612430e (diff)
downloadscala-ac9243fb9e48dd3a4829cc3bf1caf7241d40b8af.tar.gz
scala-ac9243fb9e48dd3a4829cc3bf1caf7241d40b8af.tar.bz2
scala-ac9243fb9e48dd3a4829cc3bf1caf7241d40b8af.zip
Added footer command line option to ScalaDoc so...
Added footer command line option to ScalaDoc so ScalaDoc users aren't forced to have the EPFL/Typesafe copyright notice in their API docs. Now comes with the ability for users to add their own footer. Review by ureche.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/Settings.scala')
-rw-r--r--src/compiler/scala/tools/nsc/doc/Settings.scala9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/Settings.scala b/src/compiler/scala/tools/nsc/doc/Settings.scala
index 9615b506c5..cfd6635a76 100644
--- a/src/compiler/scala/tools/nsc/doc/Settings.scala
+++ b/src/compiler/scala/tools/nsc/doc/Settings.scala
@@ -41,6 +41,13 @@ class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) {
""
)
+ val docfooter = StringSetting (
+ "-doc-footer",
+ "footer",
+ "A footer on every ScalaDoc page, by default the EPFL/Typesafe copyright notice. Can be overridden with a custom footer.",
+ ""
+ )
+
val docUncompilable = StringSetting (
"-doc-no-compile",
"path",
@@ -81,7 +88,7 @@ class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) {
// For improved help output.
def scaladocSpecific = Set[Settings#Setting](
- docformat, doctitle, docversion, docUncompilable, docsourceurl, docgenerator
+ docformat, doctitle, docfooter, docversion, docUncompilable, docsourceurl, docgenerator
)
val isScaladocSpecific: String => Boolean = scaladocSpecific map (_.name)
}