Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
R
Ragdoc Builder
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
JastAdd
Ragdoc Builder
Commits
bb829d88
Commit
bb829d88
authored
7 years ago
by
Jesper
Browse files
Options
Downloads
Patches
Plain Diff
Update README
parent
24f09b77
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
.travis.yml
+4
-0
4 additions, 0 deletions
.travis.yml
README.md
+9
-13
9 additions, 13 deletions
README.md
with
13 additions
and
13 deletions
.travis.yml
0 → 100644
+
4
−
0
View file @
bb829d88
language
:
java
jdk
:
-
oraclejdk8
This diff is collapsed.
Click to expand it.
README.md
+
9
−
13
View file @
bb829d88
# 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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment