Question

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!

Was it helpful?

Solution

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

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top