vscaladoc

A variation of scaladoc : an API generator for project written in Scala. You take a look at the api of vscaladoc it is generated with vscaladoc. Explore the demo package to see some example of the features.

Last released version : 1.1 working version : 1.2 (http://github.com/davidB/vscaladoc/tree/master)

Featurescopy content of overview.html from source directory into the generated overview.html copy content of package.html from source directory into the generated overview.html#xxx.xxxx link to source code (use same syntax highlighter as scala-blogs.org) highlight source code in the comments links between companion object and class/trait filter the list of classes by type : checkbox for classes / object / trait filter the list of classes by first charactere : begin of the name (use the textfield) filter the list of classes by package : select one or several package (Ctrl+click) define as field : val, var, nested object, def (with no Args and a return value) define as methods: every def except def classified as field or constructor merge the inherited fields and methods (hidden by default) Use ItIf you want to try it on your code (compiled with scala-2.7.1):

from shell :download the jar create a script (sample shell script : http://code.google.com/p/vscaladoc/source/browse/trunk/sc.sh) from a maven project :you need the last version (2.6) of maven-scala-plugin edit your pom.xml :
[...]

scala-tools.org
Scala-Tools Maven2 Repository
http://scala-tools.org/repo-releases

[...]

org.scala-tools
maven-scala-plugin

1.1
${scala.version}



run (-U is to force the upgrade of plugin): $> mvn scala:doc -U
or
$> mvn site -U #full site generationbrowse : target/site/scaladocs/index.html I hope you'll use vscaladoc. Every feedback, contributions are welcome (use the issue tracker).