CODEWITHSUNDEEP
javascalamavensbt
Michael Neale
Michael Neale

Reputation: 19468

Single documentation for mixed (Scala/Java) project?

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?

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

Any thoughts and experiences appreciated.

Upvotes: 12

Views: 1454

Answers (3)

Marcos
Marcos

Reputation: 41

What's de advantage of having Scaladoc <> Javadoc? There is a huge number of tools for Javadoc and almost anything for Scaladoc. The mainstream IDEs (Eclipse, Netbeans, Idea - real world enterprise development - not academic research) knows nothing about Scaladoc. Seems like being in Siberia: isolated.

Upvotes: 2

Daniel C. Sobral
Daniel C. Sobral

Reputation: 297185

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.

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.

Upvotes: 6

Pascal Thivent
Pascal Thivent

Reputation: 570335

Scaladocs and javadoc are very different, with different formats. They are just two different animals and I don't think it makes sense to combine them. So, AFAIK, Maven doesn't offer any support for that (which is not surprising), just generate both of them separately.

Upvotes: 1

Related Questions