问题标签 [scaladoc]

将以下设置添加到build.sbtPlay 2.2.x 应用程序的文件不会禁用 Scaladoc 生成。怎么可能禁用？

无法在 ipad 上读取任何 scaladoc，右下角框架不滚动，是否有任何应用程序/浏览器可以正确显示 scaladoc？

通过谷歌搜索，我没有找到任何好的和简单的解决方案。

For an in-application help browser, I would like to render API docs. Unfortunately, Scaladoc seems to produce only HTML files full of horrible JavaScript stuff, so it's impossible to render these files even with rather heavy weight components such as SwingBox (which does have very good CSS though).

So my question is: Can I leverage the Scaladoc tool or its API (if there is any) to generate some intermediate representation which I can then write out into, say, custom Markdown files or static HTML pages?

我正在尝试运行sbt test:doc，但看到许多类似于以下的警告：

[警告] /Users/tleese/code/my/stuff/src/test/scala/com/my/stuff/common/tests/util/NumberExtractorsSpecs.scala:9：找不到任何成员链接“com.my .stuff.common.util.IntExtractor”。

问题似乎是从测试源到主要源的 Scaladoc 引用无法正确链接。知道我可能做错了什么或需要配置吗？

以下是我的 Build.scala 的相关部分：

我想知道在哪里可以找到这样的代码引发的异常：

我在光滑的 scaladoc ( http://slick.typesafe.com/doc/2.0.1/api/#package )中找不到它；我在 javadoc 的 tableQuery 类中搜索了方法“first”，但没有任何成功。

谢谢。

奥利维尔

ps：这是我的答案，它正在工作：

感谢您的回答，它帮助了我。

I am running into a problem with ScalaDoc not accepting a method link when using overloading.

A standalone example: File project/build.properties:

File build.sbt:

File src/main/scala/Foo.scala:

When I run sbt doc, the [[Bar#foo]] link is fine, but the [[Bar#bar]] link is not accepted:

So using the "crash course", I tried all sorts of things, e.g.

None of this works. Neither using the other overloaded variant:

So either (like always...) scala-doc is totally broken, or I am doing something wrong?

您如何使用 sbt 链接到 Java 类apiMappings？这是我下面的代码，它适用于各种依赖项，但我不清楚如何链接到 Java 标准库类？

我知道您可以使用scaladoc 本身来生成层次结构图，但我该如何使用play doc它呢？

我正在使用 Maven 进行构建，并使用带有 Scala 插件的 IntelliJ IDEA。使用我的 pom.xml 中的 Scala 2.10.3 依赖项，该项目可以正常运行和调试。

但是当我尝试使用 IDEA 从我的整个项目中生成 Scaladocs 时，它实际上什么也没做，没有输出。

相关，我也想从 Maven 生成 Scaladocs。我已经为项目的 java 部分准备了 Javadocs。有使用 sbt 执行此操作的说明，但我找不到有关使用 Maven 执行此操作的说明。

我的 IDEA 项目有以下 Scala 库

我在 SBT 中构建了一个多项目 Scala，其中我有一个根项目，它实际上只是聚合了两个子项目：一个宏库和一个使用该宏库的核心库。

我正在使用出色的插件为整个库（宏 + 核心相结合）sbt-unidoc创建一个统一的 API。scaladoc

不幸的是，sbt-unidoc有一些限制。例如，默认情况下，它不会挂接到doc任务中，并且其输出放置在目标目录的unidoc文件夹中，而不是api文件夹中。publish结合起来，这些可以防止在执行orpublishLocal命令时生成和打包生成的文档。幸运的是（感谢GitHub网站上提出的问题），有一个简单的解决方案：inkytonicsbt-unidoc

然后在根项目中使用这些设置：

现在，如果您执行 sbt 任务doc, publish,publishLocal等，该root项目将为两个子项目生成统一文档，并且该统一文档在发布期间被打包。

不幸的是，这些相同的命令还尝试为子项目macro和core子项目生成单独的子项目 API 文档——在我的特定情况下，由于各种原因，这些命令将失败。更不用说生成两次文档需要时间。

所以，这是我的问题：有什么简单的方法可以禁用doc每个子项目的任务吗？

到目前为止，我能够发现的唯一方法是欺骗doc认为没有嵌入 Scaladoc 的文件。这可行，但它是一种软糖而不是真正的解决方案：

有什么建议么？