This is a custom Doclet that generates JSON files based on Javadoc comments in .java
files. These JSON files have all the information necessary for building the reference pages on processing.org.
The Doclet will run through the .java
file in the following repositories:
It will read the JavaDoc comments, create a series of .json
files, and save them into the Processing website repository in the content/references/translations/en/
folder:
First, make sure that you have the proper setup before running the script:
- Clone down whichever repository listed above that you need to have updated on the website. You will need at least one of
processing/processing4
,processing/processing-sound
orprocessing/processing-video
alongside theprocessing/processing-website
repo. The repositories need to be alongside each other in the same folder. - Make sure you have Java JDK 11 installed and the
JAVA_HOME
environment variable set to point to the installation. The name of the JDK file may vary depending on your exact version (e.g.export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-11.0.8.jdk/Contents/Home/
). - Make sure you have Apache Ant installed in version 1.8 or above.
Now you are ready to run the doclet
- First
cd
into theprocessing-doclet/ReferenceGenerator
folder - Run
ant compile
- Run
./processingrefBuild.sh
if you are updating all the repositories or./processingrefBuild.sh processing
,./processingrefBuild.sh sound
or./processingrefBuild.sh video
if you are updating a single repository. - After the new JSON files are created, move into
processing-website
and runnpx prettier --write content/references
to format the JSON
If you just want to test the Doclet without the processing-website
repo, you can create the following folder structure in the root folder and see the files:
processing-website/content/references/translations/en/