问题标签 [scaladoc]

我想要像这样的链接

• Javadoc{@link Object#toString()}
• 斯卡拉多克[[Object#toString()]]

我怎么能用 scaladoc 做到这一点？

我假设我必须提供要链接到的外部 URL。

假设我的整个项目配置很简单build.sbt：

这是我的代码：

现在，当我sbt doc在浏览器中运行并打开 API 文档时，我会scalaz在 ScalaDoc 根包列表中看到该包，以及我的Foo：

或者，如果你不相信我：

我之前在 Scalaz 中注意到了这一点，而且我不是唯一一个发生这种情况的人（例如，参见当前发布的 Argonaut API 文档版本）。我不确定我是否在 Scalaz 以外的任何库中看到过这种情况。

如果我在项目代码中实际上没有使用 Scalaz 中的任何东西，它就不会出现。同样的事情至少发生在 2.10.4 和 2.11.4 上。

为什么scalaz包裹会出现在这里，我怎样才能让它停止？

我在 Eclipse 中使用 Apache Spark Java API，但是当我单击 Eclipse 中的方法和类时，将打开 Apache Spark 的 Scaladoc 版本！我怎么解决这个问题？

Play 似乎通过“build”或“doc”命令生成文档。

我们应该如何使用这个功能？

• 它是否生成文本文件？
• 它是生成html文件吗？
• 我如何查阅该文档？
• 它甚至是为人类制造的还是内部的东西？

我正在使用 sbt 0.13.7 和 Scala 2.11.4。

在我的build.sbt，我有：

在一个File.scala：

运行时sbt doc，我得到：

现在，当我替换autoAPIMappings := true为：

编译器仍然给出警告。

有什么解决办法？

我正在使用sbt doc为 Scala 项目生成文档。

使用默认设置，文档会自动显示继承的成员，如下面的屏幕截图所示。

理想情况下，我想生成默认隐藏所有继承成员的文档，如下所示。

如何生成文档以使其仅显示明确定义的成员？

我有一个多项目 SBT 配置。我有一堂课my.AClass。 project1我应该在配置中添加什么来制作 scaladoc，如下所示

在 project2 中被成功编译sbt project2/doc？

我正在研究一个数学函数库。作为 的一部分Scaladoc，我想包括每个函数的公式。例如

我正在使用MathJax来显示公式。如果我手动编辑生成的 html 以包含所需的 MathJax javascript，它会起作用，但我想自动执行此操作。

到目前为止，我发现的唯一解决方案是：

• 有没有办法在 Scaladoc 中包含数学公式？
• 使用 doc 任务生成 scaladoc 后如何运行 bash 脚本？

如果这些是唯一的选项，那没关系，但是我想只使用 sbt（没有外部脚本）来做到这一点。有没有办法通过scalacOptions在How to ScalaDoc中设置来做到这一点？

我可以通过手动使用“scaladoc -diagrams ...”生成类层次结构图

我还可以通过“mvn scala:doc”使用 Maven 生成基本的 ScalaDoc

但是当我从 Maven 运行 ScalaDoc 时，我怎样才能把“-diagrams”放进去呢？一般来说，我如何输入“scaladoc -help”中列出的任何选项。

我的 pom.xml 中有这个，但它不起作用。

更新

这也不起作用：

我将 Gradle (v2.3) 用于包含多个 Scala 子项目的项目。为每个子项目单独生成 ScalaDoc 按预期工作（运行gradle :project-a:scaladoc或gradle :project-b:scaladoc）。

但是如何获得所有Scala 子项目的单个ScalaDoc ？下面的最小项目在执行时会导致“Cannot invoke method withInputStream() on null object”错误
gradle scaladoc --info：

目录结构：

构建.gradle

设置.gradle

斯卡拉

斯卡拉

我能找到的唯一类似问题是“Gradle Fails to Compile Basic Sc​​ala Project”，但在这里没有帮助（关于 Gradle 1.3）。