8

我需要从我的 scaladoc 链接到 github 上的资源。doc我用 sbt 的任务来构建这些文档。

有两个问题 - 首先,我不喜欢为我的.scala文件创建多个嵌套的空目录,所以我通常将它们打包成一个 - 比如src/main/scala/org.rogach.scallop而不是src/main/scala/org/rogach/scallop. 有没有办法在不拆分该目录的情况下使指向文档的链接起作用?

其次,当我将此行放入 build.sbt 时:

scalacOptions in (Compile, doc) ++=
  Opts.doc.sourceUrl("https://raw.github.com/Rogach/scallop/master/src/main/scala/")

docs 包含指向源的链接,但所有这些链接仅指向源根 url,而不是文件本身。我究竟做错了什么?

4

1 回答 1

7

从输出scaladoc help

-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')

(是的,那是欧元符号。)

如果您的所有源都在包中定义,则类似以下内容应作为 sourceUrl 的参数:

https://raw.github.com/Rogach/scallop/master/src/main/scala/€{TPL_OWNER}.€{TPL_NAME}.scala
于 2012-05-02T23:27:45.127 回答