Para un proyecto con módulos en Scala y Java (uno al lado del otro), ¿cómo combinar scaladoc con javadoc para proporcionar una vista única de la documentación del proyecto?¿Documentación única para proyecto mixto (Scala/Java)?
(esto podría estar usando maven, o hormiga, o sbt, más una pregunta general).
Cualquier pensamiento y experiencia apreciada.
Con el nuevo Scaladoc de Scala 2.8 que reemplazará el que se usa con Scala 2.7, las diferencias serán aún más sorprendentes. Sin embargo, se solicitó que se proporcionara una función que tradujera scaladoc al formato javadoc, para que los IDE lo utilicen cuando muestren ayuda.
Si esta función está disponible, entonces algo que genere javadocs de scaladocs sería teóricamente factible.
Pero para que todo eso se haga realidad, las personas que tienen interés en tal cosa tendrían que hablar en los foros apropiados. Y, por supuesto, si son un grupo demasiado pequeño, es probable que no suceda nada a menos que lo hagan por sí mismos.
Mis pensamientos son más parecidos a las personas que crean bibliotecas en scala, que una vez se crearon en java. Entonces, los usuarios de java lang pueden querer usarlos: el hecho de que la biblioteca esté escrita en scala no tiene que preocupar demasiado al consumidor. Para este propósito, scaladoc es adecuado, pero supongo que si realmente quieres ocultar el hecho de que es scala, no lo corta, lo analizaré más adelante, ¡gracias por tu respuesta! –
Scaladocs y javadoc son muy diferentes, con diferentes formatos. Son solo dos animales diferentes y no creo que tenga sentido combinarlos. Entonces, AFAIK, Maven no ofrece ningún soporte para eso (lo cual no es sorprendente), solo genere ambos por separado.
¿Cuál es la ventaja de tener Scaladoc <> Javadoc? Hay una gran cantidad de herramientas para Javadoc y casi cualquier cosa para Scaladoc. Los IDE dominantes (Eclipse, Netbeans, Idea, desarrollo empresarial en el mundo real, no investigación académica) no saben nada de Scaladoc. Parece estar en Siberia: aislado.
Supongo que ese era mi punto. Si está escribiendo una biblioteca para el consumo general, y quiere que a los consumidores no les importe, está escrito en scala, entonces javadoc sería bueno (por supuesto, debe tener cuidado al escribir la scala para la interfaz pública de todos modos). –
+1 Incluso si ScalaDoc y JavaDoc permanecen separados, sería genial poder realizar referencias cruzadas. – Raman