Ho un progetto Scala sotto sbt. Mi piacerebbe generare un javadoc per questo come la maggior parte degli utenti dell'API del progetto sono sviluppatori Java. È possibile?Come generare documentazione in stile javadoc per progetto solo Scala in sbt?
% sbt doc
troverete i risultati in target/scala-version/api (supponendo che si sta utilizzando un semplice progetto di SBT che non ha più sotto-progetti).
Aggiornamento:
sperimentazione dimostra che il comando di SBT doc genera documentazione per sia le fonti Scala e Java nel progetto.
Suppongo che desideri i tuoi documenti in formato JavaDoc per avere qualcosa di familiare alle persone che vengono utilizzate nelle librerie java?
C'è un progetto dal dossier chiamato GenJavaDoc che potrebbe essere quello che stai cercando. Genera doc per una libreria di scala in un formato molto simile a javadoc. Può essere integrato in una build sbt.
Akka ha una java api molto completa e molti utenti di Akka provengono dal mondo Java, quindi ovviamente ne hanno bisogno.
Akka japi docs generated by the tool
Blog post by Roland Kuhn describing the tool and the rationale
penso doc sbt genera Scala doc –
Qual è la differenza? È HTML che descrive il tuo codice. –
Là ** È ** una differenza per l'OP che ha chiesto di avere la documentazione in stile javadoc per ** Scala ** types => downvoted. –