Autogenerated documentation for a mixed java/scala project

只愿长相守 提交于 2019-12-12 09:47:17

问题


I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the structure right, but does not include the documentation. And javadoc obviously only covers the Java part.

We looked at Doxygen, but it doesn't work with Scala out of the box, so that's a bit of a research project.

How can we do this short of going 100% Java or 100% Scala?

Thanks!


回答1:


Play Framework generates scaladoc for its Scala classes and javadoc for its Java classes. See generateAPIDocsTask: https://github.com/playframework/Play20/blob/master/framework/project/Build.scala



来源:https://stackoverflow.com/questions/8359517/autogenerated-documentation-for-a-mixed-java-scala-project

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!