diff options
| author | Masato Sogame <poketo7878@gmail.com> | 2014-07-12 23:47:10 +0900 |
|---|---|---|
| committer | Antoine Gourlay <antoine@gourlay.fr> | 2014-08-11 17:56:17 +0200 |
| commit | 771724494d4a7e73542c04e8e0b50523745fb7a8 (patch) | |
| tree | a434b8d8584874547ed36a1bf680e76c8dec0758 /src/scaladoc/scala/tools/nsc/doc/Settings.scala | |
| parent | 40beefbb750d326a5ae71ed852c58dc9a31d7e17 (diff) | |
| download | scala-771724494d4a7e73542c04e8e0b50523745fb7a8.tar.gz scala-771724494d4a7e73542c04e8e0b50523745fb7a8.tar.bz2 scala-771724494d4a7e73542c04e8e0b50523745fb7a8.zip | |
[backport] Rewrite explanation of doc-source-url option more clearly, and fix encoding to show euro-sign correctly.
(cherry picked from commit 13054daa658484df30b71447dbe684f475537252)
Diffstat (limited to 'src/scaladoc/scala/tools/nsc/doc/Settings.scala')
| -rw-r--r-- | src/scaladoc/scala/tools/nsc/doc/Settings.scala | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/scaladoc/scala/tools/nsc/doc/Settings.scala b/src/scaladoc/scala/tools/nsc/doc/Settings.scala index a8e1dee4a0..44683f1755 100644 --- a/src/scaladoc/scala/tools/nsc/doc/Settings.scala +++ b/src/scaladoc/scala/tools/nsc/doc/Settings.scala @@ -66,7 +66,7 @@ class Settings(error: String => Unit, val printMsg: String => Unit = println(_)) val docsourceurl = StringSetting ( "-doc-source-url", "url", - "A URL pattern used to build links to template sources; use variables, for example: ?{TPL_NAME} ('Seq'), ?{TPL_OWNER} ('scala.collection'), ?{FILE_PATH} ('scala/collection/Seq')", + s"A URL pattern used to link to the source file; the following variables are available: €{TPL_NAME}, €{TPL_OWNER} and respectively €{FILE_PATH}. For example, for `scala.collection.Seq`, the variables will be expanded to `Seq`, `scala.collection` and respectively `scala/collection/Seq` (without the backquotes). To obtain a relative path for €{FILE_PATH} instead of an absolute one, use the ${sourcepath.name} setting.", "" ) |