Documentação única para o projeto misto (Scala/Java)?

Question

Para um projeto com módulos em Scala e Java (lado a lado), como combinar o ScalAdoc com o Javadoc para fornecer uma única visão da documentação para o projeto?

(Isso pode estar usando maven, ou formiga, ou SBT, mais uma pergunta geral).

Quaisquer pensamentos e experiências apreciados.

Answer 1

Com o novo ScalAdoc do Scala 2.8 que substituirá o usado pelo Scala 2.7, as diferenças serão ainda mais impressionantes. No entanto, houve um pedido de que fosse fornecida uma função que traduzisse o ScalAdoc no formato Javadoc, para uso por IDEs ao exibir ajuda.

Se essa função estiver disponível, algo que gera javadocs a partir de scaladocs seria teoricamente viável.

Mas, para que isso se torne verdadeiro, as pessoas que têm interesse em tal coisa teriam que falar nos fóruns apropriados. E, é claro, se eles são um grupo muito pequeno, é provável que nada aconteça, a menos que façam isso por si mesmos.

Answer 2

O que é vantagem de ter ScalAdoc <> javadoc? Há um grande número de ferramentas para Javadoc e quase tudo para o ScalAdoc. O Mainstream IDES (Eclipse, Netbeans, Idea - Desenvolvimento de Empresas do Mundo Real - não pesquisas acadêmicas) não sabe nada sobre o ScalAdoc. Parece estar na Sibéria: isolado.

Answer 3

Scaladocs e Javadoc são muito diferentes, com formatos diferentes. São apenas dois animais diferentes e acho que não faz sentido combiná -los. Portanto, Afaik, o Maven não oferece suporte para isso (o que não é surpreendente), apenas gerar os dois separadamente.