to generate apidocs / scaladoc for your scala sources, add this to your pom.xml
<project> ... <reporting> <plugins> ... <plugin> <groupId>org.scala-tools</groupId> <artifactId>maven-scala-plugin</artifactId> </plugin> ... </plugins> </reporting> ... </project>
Place scala sources files in :
src/main/scala
Then use the standard maven phases :
# generate a site mvn site
Or the plugin specifics goal :
# generate only the doc mvn scala:doc
See the result under target/site/scaladocs/
You need to declare the main class to call (with the same parameter as scaladoc). And you need to list the additional artifact(jar) to use :
<configuration> <scaladocClassName>org.scala_tools.vscaladoc.Main</scaladocClassName> <scalaJars> <scalaJar> <groupId>org.scala-tools</groupId> <artifactId>vscaladoc</artifactId> <version>1.0</version> </scalaJar> </scalaJars> </configuration>
Then use the standard maven phases :
# generate a site mvn site # or generate only the doc mvn scala:doc
See the result under target/site/scaladocs/
vscaladoc have a shortcut way to use it (instead of using the custom way describe above) :
<configuration> <vscalaVersion>1.0</vscalaVersion> </configuration>
Then use the standard maven phases :
# generate a site mvn site # or generate only the doc mvn scala:doc
See the result under target/site/scaladocs/