Home > Scajadoc

Scajadoc

Scajadoc is a project mainly written in SCALA and JAVASCRIPT, it's free.

Tool for generating Java API from Scala sources.

Scajadoc is an open source (LGPL licensed) javadoc generation tool.

Tool is distributed along with the maven plugin.

Building and executing Scajadoc.

1.) Build top level module first
        mvn clean install

2.) Either run

        java -jar Scajadoc with command lines parameters (TODO describe them)

        or

        add this entry to your pom.xml

        <plugin>
            <groupId>org.scajadoc</groupId>
            <artifactId>scajadoc-maven-plugin</artifactId>
            <version>1.0.ALPHA</version>
            <configuration>
                <scalaVersion>2.8.1</scalaVersion>
                <links>
                   <param>link to root of the external APIs (for instance: http://download.oracle.com/javase/6/docs/api/)</param>
                </links>
            </configuration>
        </plugin>

        and execute:

        mvn scajadoc:run

        Documentation will be generated in target/scajadoc directory.
        TODO automatic discovery of scala version

  sample configuration:

  <plugin>
        <groupId>org.scajadoc</groupId>
        <artifactId>scajadoc-maven-plugin</artifactId>
        <version>1.0.ALPHA</version>
        <configuration>
            <scalaVersion>2.8.1</scalaVersion>
            <links>
                <param>http://download.oracle.com/javase/6/docs/api/</param>
            </links>
        </configuration>
    </plugin>
Previous:ll