问题标签 [scaladoc]

我写了这样的评论：

我希望代码缩进，但生成的 HTML 如下所示：

这是一个错误，还是...？我正在使用 Scala 2.11.0。

我有一个包含示例 Java servlet 配置的评论。看起来像：

注释中的/*Scala 在 Scala 中创建了一个嵌套块注释，这似乎使 scaladoc 工具感到困惑。有没有办法/*在块评论中逃脱？或者另一种显示该文本的方式？

有人建议使用实体 / 对于斜线，但实体在 {{{ }}} 代码块内不起作用。

我目前正在编写用 Scala 编写的 API 的文档。我想包括几个图表以使代码更易于理解。

我想知道将资源（例如图表）放在哪里，以便可以通过调用 scaladoc 自动导入它们，以及如何在代码文档中引用这些资源。

例如，假设我使用 sbt。我的代码位于src/main/scala目录中。以下是 package 的 scala 包对象示例foo：

'diagram-foo.svg' 应该位于我的项目中的哪个位置以便对 scaladoc 可见？随后，标签path/to/中的正确值是什么？img

由于需要同时使用 Eclipse 和 sbt，我有一些非标准的 sbt 构建设置。

我的来源在src/main/scala和src/com/companyname/[folder1, folder2, etc]目录中。

如何设置 sbt 以便它还为这些附加folderX文件夹生成文档src/com/companyname？

我想为我班级的每个 val 和 def 创建 ScalaDoc 条目。问题是 vals 位于模式定义中，并且不知道如何使用/** */语法。

例子：

如何记录part1和part2？

在询问有关 ScalaDoc 的文档之前，我已经阅读过。

在 Play 项目（当前使用 Play 2.3.0）上执行“dist”时，如何阻止 scaladoc 运行？举个例子：

该过程的“scaladoc”部分大约需要20 秒中的12秒。我根本不想运行 scaladoc （任何在这个非库项目上工作的人都会查看实际的源代码）。

Scala API中有很多地方，特别是在集合中，方法签名是错误的。

例如，Map的 scaladoc 签名。flatMap说

但实际签名是

这个特别没有意义，因为 scaladoc 签名包括Map[B], 但Map有两个类型参数，而不是一个。

这里发生了什么？这是一个错误吗？

我在 Gradle 中有一个多模块 scala 项目。除了 ScalaDoc，一切都很好。我想生成一个所有库都交叉链接的“uber-scaladoc”。我对 groovy/gradle 还是很陌生，所以这可能是一个“我”的问题。获得此设置的任何帮助将不胜感激。

这里的目标是能够在命令行中运行“gradle doScalaDoc”并显示汇总文档。

提前致谢。

当我尝试从 sbt 任务中调用 scaladoc 时，我遇到了 MissingRequirementError。

使用任何版本的 sbt 0.13.x，从这个开始build.sbt：

然后运行sbt scaladoc，看看（期间makeUniverse）：

这里有什么问题？我已经尝试过fork := truesbt/scala 版本的不同组合，但无济于事。

我正在使用 Eclipse 编写 Scala 代码。

我在 Eclipse 中安装了 Scala 插件。在 Eclipse 的 Java 环境中，每个内置方法都有可用的解释，但对于 Scala，Eclipse 不显示 Scala 文档。

如何在 Eclipse 中查看 Scaladoc？