如何在sbt中为Scala-only项目生成javadoc样式的文档?

Sri*_*ian 8 java scala sbt

我在sbt下有一个Scala项目.我想为它生成一个javadoc,因为项目API的大多数用户都是Java开发人员.这可能吗?

Rüd*_*ehn 7

我假设你想要你的JavaDoc格式的文档,以便熟悉那些习惯于java库的人吗?

来自类型安全的名为GenJavaDoc的项目可能正是您所寻找的.它以与javadoc非常相似的格式为scala库生成文档.它可以集成到sbt构建中.

Akka有一个非常完整的java api,Akka的许多用户来自java世界,所以显然他们需要这个.

项目存储库

Akka japi由该工具生成的文档

Roland Kuhn的博客文章描述了该工具和基本原理


Ran*_*ulz 5

% sbt doc
Run Code Online (Sandbox Code Playgroud)

您将在中找到结果target/scala-version/api(假设您使用的是一个没有多个子项目的简单SBT项目)。

更新:

实验表明,SBT的doc命令生成的文档在项目中Scala和Java源代码。

  • 我认为sbt doc生成scala doc (3认同)