HTTPS SSH

RagDoc Builder

This is a tool for building documentation metadata about JastAdd applications.

Run RD-Builder on the generated Java code of your JastAdd project as if compiling the code. RD-Builder outputs a bunch of JSON files describing the structure of the input classes. The generated documentation can be viewed with RagDoc Viewer.

RagDoll depends on the following projects:

  • extendj
  • se.llbit:jo-json

Building

Build the tool with Gradle:

./gradlew fatJar
java -jar rd-builder.jar -version

Usage

Run RagDoc Builder just like a regular Java compiler. The output is written to the path specified by the -d option:

java -jar rd-builder.jar -d docs -classpath $CLASSPATH File1.java ...

The documentation is generated as a set of .json files containing information about the classes and attributes in the input sources. This information can be viewed on a webpage using RagDoc Viewer.