diff options
| author | Masato Sogame <poketo7878@gmail.com> | 2014-07-12 23:47:10 +0900 |
|---|---|---|
| committer | Masato Sogame <poketo7878@gmail.com> | 2014-07-13 02:50:43 +0900 |
| commit | 13054daa658484df30b71447dbe684f475537252 (patch) | |
| tree | 5fe4059f014d31f16105ff3c7c164fb9a4c1f633 /src/scaladoc | |
| parent | b1b0b5c58ece31b767de93ec49455b72b3b229b7 (diff) | |
| download | scala-13054daa658484df30b71447dbe684f475537252.tar.gz scala-13054daa658484df30b71447dbe684f475537252.tar.bz2 scala-13054daa658484df30b71447dbe684f475537252.zip | |
Rewrite explanation of doc-source-url option more clearly, and fix encoding to show euro-sign correctly.
Diffstat (limited to 'src/scaladoc')
| -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 67529f4178..02929c5ecb 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.", "" ) |