我在sbt下有一个Scala项目。我想为它生成一个javadoc,因为项目API的大多数用户都是Java开发人员。这可能吗?
答案 0 :(得分:7)
我假设您希望使用JavaDoc格式的文档,以便熟悉那些习惯于使用Java库的人吗?
有一个名为 GenJavaDoc 的类型安全项目,可能就是你要找的东西。它以与javadoc非常相似的格式为scala库生成文档。它可以集成到sbt构建中。
Akka有一个非常完整的java api,Akka的许多用户来自java世界,显然他们需要这个。
Akka japi docs generated by the tool
Blog post by Roland Kuhn describing the tool and the rationale
答案 1 :(得分:4)
% sbt doc
您将在target/scala-version/api
中找到结果(假设您使用的是一个没有多个子项目的简单SBT项目。)
<强>更新强>
实验表明,SBT的doc
命令为项目中的和 Scala和Java源生成文档。