Skip to content
Snippets Groups Projects
Commit bb829d88 authored by Jesper's avatar Jesper
Browse files

Update README

parent 24f09b77
Branches
No related tags found
No related merge requests found
language: java
jdk:
- oraclejdk8
# RagDoc Builder # RagDoc Builder
This is a tool for building documentation metadata about JastAdd applications. This is a tool for building documentation metadata for JastAdd projects.
RD-Builder outputs JSON files with documentation metadata. The documentation
can be viewed with RagDoc Viewer.
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 ## Building
Build the tool with Gradle: Build the tool with Gradle:
...@@ -23,8 +15,8 @@ Build the tool with Gradle: ...@@ -23,8 +15,8 @@ Build the tool with Gradle:
## Usage ## Usage
Run RagDoc Builder just like a regular Java compiler. The output is written to Run RagDoc Builder on the generated JastAdd code, just like a regular Java compiler.
the path specified by the `-d` option: The output is written to the path specified by the `-d` option:
java -jar rd-builder.jar -d docs -classpath $CLASSPATH File1.java ... java -jar rd-builder.jar -d docs -classpath $CLASSPATH File1.java ...
...@@ -32,3 +24,7 @@ the path specified by the `-d` option: ...@@ -32,3 +24,7 @@ the path specified by the `-d` option:
The documentation is generated as a set of `.json` files containing information about 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 the classes and attributes in the input sources. This information can be viewed on
a webpage using RagDoc Viewer. a webpage using RagDoc Viewer.
RagDoc Builder can also be run using JastAddGradle. By running RagDoc Builder
this way, you won't have to set up the full compile path because JastAddGradle
knows how to compile the generated JastAdd code.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment