Sorcerer

Download (changelog)

Sorcerer is a source code cross reference generator. It analyzes a set of Java source files and produce HTML files that shows annotated source code. Unlike some of the other similar tools like JXR, sorcerer understands Java AST like IDEs, and therefore provide much richer navigation in the HTML files. For example, you can jump to the definition to the method from every invocation (it even handles overloaded methods correctly), or jump to the derived classes from any class, etc.

Take a look at the sample report to see it in action.

Running sorcerer requires JDK6.

Features

1. Sorcerer builds Java AST, and therefore its navigation parallels that of modern IDEs.
2. Jump to subclasses, overriding methods, etc.
3. Usable clean URLs. Every declaration has a permalink.

Using sorcerer from CLI

A typical invocation of sorcerer would look like the following:

$ java -jar sorcerer.jar -d path/to/output -cp $CLASSPATH path/to/srcdir

Notice that sorcerer can generate a better report if it has access to the dependency jar files. For the list of complete options, run sorcerer.jar without any argument.

Using sorcerer from Ant

Sorcerer comes with Ant task for automation.

<taskdef resource="org/jvnet/sorcerer/ant.properties">
  <classpath>
    <pathelement path="path/to/sorcerer.jar"/>
  </classpath>
</taskdef>
<sorcerer srcdir="path/to/src" destdir="path/to/output">
  <classpath>
    ... list of dependency jar files, just like you'd specify it for javac ...
  </classpath>
</sorcerer>

For more information about the Ant task, see this document.

Using sorcerer from Maven

Sorcerer has a Maven plugin for those projects that use Maven2. To use this, add the following to your pom.xml

<reporting>
  <plugins>
    <plugin>
      <groupid>org.jvnet.sorcerer</groupid>
      <artifactid>maven-sorcerer-plugin</artifactid>
    </plugin>
  </plugins>
</reporting>

You'd also need to have the java.net maven2 repository in your registered repository list, so that you can download the latest version of the plugin automatically. See this document for more about how to do that.

For more information about the maven task, see this document.

Acknowledgements

• Sorcerer is built on top of javac tree API.
• Icons are licensed under Eclipse Public License.