diff options
| author | Gilles Dubochet <gilles.dubochet@epfl.ch> | 2010-02-03 17:03:58 +0000 |
|---|---|---|
| committer | Gilles Dubochet <gilles.dubochet@epfl.ch> | 2010-02-03 17:03:58 +0000 |
| commit | a6eecfb04532c83a715d520e885250e8de808f9e (patch) | |
| tree | cbfbf98476467a63c3e28652e767a431655ca46e /src/compiler/scala/tools/nsc/doc/Settings.scala | |
| parent | 909924acba60dadee5647e405c0bb9a2676f4a70 (diff) | |
| download | scala-a6eecfb04532c83a715d520e885250e8de808f9e.tar.gz scala-a6eecfb04532c83a715d520e885250e8de808f9e.tar.bz2 scala-a6eecfb04532c83a715d520e885250e8de808f9e.zip | |
[scaladoc] Optional link to source (set paramet...
[scaladoc] Optional link to source (set parameter "-doc-source-url").
Support for commenting packages (using package objects). Contributed by
Perdo Furlanetto. Also: small performance improvements, short comment
extraction is more robust (but no HTML tags allowed in first sentence),
small code clean-ups. Checked by dubochet, no review.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/Settings.scala')
| -rw-r--r-- | src/compiler/scala/tools/nsc/doc/Settings.scala | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/Settings.scala b/src/compiler/scala/tools/nsc/doc/Settings.scala index 75aff8e4bd..0ea17970f6 100644 --- a/src/compiler/scala/tools/nsc/doc/Settings.scala +++ b/src/compiler/scala/tools/nsc/doc/Settings.scala @@ -26,6 +26,10 @@ class Settings(error: String => Unit) extends scala.tools.nsc.Settings(error) { * documented. 'Note:'' This setting is currently not used. */ val docversion = StringSetting ("-doc-version", "doc-version", "An optional version number, to be appended to the title", "") + /** 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 docsourceurl = StringSetting ("-doc-source-url", "url", "The URL prefix where documentation will link to sources", "") + // working around issue described in r18708. suppressVTWarn.value = true |