混合(Scala/Java)项目的单一文档? [英] Single documentation for mixed (Scala/Java) project?

问题描述

对于一个具有Scala和Java模块(并排)的项目，如何将scaladoc和javadoc结合使用以提供该项目文档的单一视图?

For a project with modules in Scala and Java (side by side), how to combine scaladoc with javadoc to provide a single view of the documentation for the project?

(这可能是使用maven或ant或sbt，更常见的问题).

(this could be using maven, or ant, or sbt, more a general question).

任何想法和经验都值得赞赏.

Any thoughts and experiences appreciated.

推荐答案

使用Scala 2.8的新scaladoc将取代Scala 2.7所使用的scaladoc，两者之间的差异将更加显着.但是，有人要求提供一个将scaladoc转换为javadoc格式的函数，以供IDE在显示帮助时使用.

With Scala 2.8's new scaladoc that will replace the one used with Scala 2.7, the differences will be even more striking. However, there was a request that a function be provided that translated scaladoc into javadoc format, for use by IDEs when displaying help.

如果此功能可用，那么从scaladocs生成javadocs的东西在理论上将是可行的.

If this function becomes available, then something that generates javadocs from scaladocs would be theoretically feasible.

但是，要使任何事情成真，对这种事情感兴趣的人必须在适当的场合大声疾呼.而且，当然，如果他们太小了，除非他们自己做，否则很可能不会发生任何事情.

But for any of that to become true, the people who have interest in such a thing would have to speak up at the appropriate fora. And, of course, if they are too small a group, it is likely nothing happens unless they do it for themselves.

这篇关于混合(Scala/Java)项目的单一文档?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！