Skip to content

Commit 299c942

Browse files
committed
Adding arguments to doclet script
1 parent fc6dccb commit 299c942

File tree

2 files changed

+52
-21
lines changed

2 files changed

+52
-21
lines changed

doclet/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ You also need to have [Apache Ant](https://ant.apache.org/manual/install.html) i
2222
Now run the Doclet:
2323

2424
1. First move into the `processing4/doclet/ReferenceGenerator` folder
25-
1. Run `ant compile`
26-
1. Run `./processingrefBuild.sh`
25+
2. Run `ant compile`
26+
3. Run `./processingrefBuild.sh` **note:if you want to run the script just for the main processing references(including libraries serial, net and io) you should run `./processingrefBuild.sh processing` and if you want to run the script for sound or video library you should run `./processingrefBuild.sh sound` or `./processingrefBuild.sh video`**
2727

2828
If you are only updating the processing reference and not the sound or video libraries, you can comment out the part related to those libraries in the `processingrefBuild.sh` file. Please remember to not commit these changes to the repo.
2929

doclet/ReferenceGenerator/processingrefBuild.sh

Lines changed: 50 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,55 @@ REFERENCES_OUT_PATH=../../../processing-website/content/references/translations/
1111
echo "[REFERENCE GENERATOR] Source Path :: $PROCESSING_SRC_PATH"
1212
echo "[REFERENCE GENERATOR] Library Path :: $PROCESSING_LIB_PATH"
1313

14-
15-
echo "[REFERENCE GENERATOR] Removing previous version of the ref..."
16-
rm -rf $REFERENCES_OUT_PATH
17-
mkdir $REFERENCES_OUT_PATH
18-
mkdir $REFERENCES_OUT_PATH/processing
19-
mkdir $REFERENCES_OUT_PATH/io
20-
mkdir $REFERENCES_OUT_PATH/net
21-
mkdir $REFERENCES_OUT_PATH/serial
22-
mkdir $REFERENCES_OUT_PATH/sound
23-
mkdir $REFERENCES_OUT_PATH/video
14+
#you can pass one argument "sound" or "video" to generate those libraries separately
15+
#if there is no argument it will generate everything
16+
if [ $# -eq 0 ]
17+
then
18+
echo "No arguments supplied, generating everything"
19+
echo "[REFERENCE GENERATOR] Removing previous version of the ref..."
20+
rm -rf $REFERENCES_OUT_PATH
21+
mkdir $REFERENCES_OUT_PATH
22+
mkdir $REFERENCES_OUT_PATH/processing
23+
mkdir $REFERENCES_OUT_PATH/io
24+
mkdir $REFERENCES_OUT_PATH/net
25+
mkdir $REFERENCES_OUT_PATH/serial
26+
mkdir $REFERENCES_OUT_PATH/sound
27+
mkdir $REFERENCES_OUT_PATH/video
28+
FOLDERS="$PROCESSING_SRC_PATH/processing/core/*.java \
29+
$PROCESSING_SRC_PATH/processing/data/*.java \
30+
$PROCESSING_SRC_PATH/processing/event/*.java \
31+
$PROCESSING_SRC_PATH/processing/opengl/*.java \
32+
$PROCESSING_LIB_PATH/io/src/processing/io/*.java \
33+
$PROCESSING_LIB_PATH/net/src/processing/net/*.java \
34+
$PROCESSING_LIB_PATH/serial/src/processing/serial/*.java \
35+
$PROCESSING_LIB_PATH/../../../processing-video/src/processing/video/*.java \
36+
$PROCESSING_LIB_PATH/../../../processing-sound/src/processing/sound/*.java"
37+
elif [ $1 = "processing" ]
38+
then
39+
echo "Generating processing references"
40+
echo "[REFERENCE GENERATOR] Removing previous version of the ref..."
41+
rm -rf $REFERENCES_OUT_PATH/processing
42+
rm -rf $REFERENCES_OUT_PATH/io
43+
rm -rf $REFERENCES_OUT_PATH/net
44+
rm -rf $REFERENCES_OUT_PATH/serial
45+
mkdir $REFERENCES_OUT_PATH/processing
46+
mkdir $REFERENCES_OUT_PATH/io
47+
mkdir $REFERENCES_OUT_PATH/net
48+
mkdir $REFERENCES_OUT_PATH/serial
49+
FOLDERS="$PROCESSING_SRC_PATH/processing/core/*.java \
50+
$PROCESSING_SRC_PATH/processing/data/*.java \
51+
$PROCESSING_SRC_PATH/processing/event/*.java \
52+
$PROCESSING_SRC_PATH/processing/opengl/*.java \
53+
$PROCESSING_LIB_PATH/io/src/processing/io/*.java \
54+
$PROCESSING_LIB_PATH/net/src/processing/net/*.java \
55+
$PROCESSING_LIB_PATH/serial/src/processing/serial/*.java"
56+
else
57+
echo "Generating $1 library"
58+
echo "[REFERENCE GENERATOR] Removing previous version of the ref..."
59+
rm -rf $REFERENCES_OUT_PATH/$1
60+
mkdir $REFERENCES_OUT_PATH/$1
61+
FOLDERS="$PROCESSING_LIB_PATH/../../../processing-$1/src/processing/$1/*.java"
62+
fi
2463

2564
echo "[REFERENCE GENERATOR] Generating new javadocs..."
2665
javadoc -doclet ProcessingWeblet \
@@ -33,13 +72,5 @@ javadoc -doclet ProcessingWeblet \
3372
-includedir ../../content/api_en/include \
3473
-imagedir images \
3574
-encoding UTF-8 \
36-
$PROCESSING_SRC_PATH/processing/core/*.java \
37-
$PROCESSING_SRC_PATH/processing/data/*.java \
38-
$PROCESSING_SRC_PATH/processing/event/*.java \
39-
$PROCESSING_SRC_PATH/processing/opengl/*.java \
40-
$PROCESSING_LIB_PATH/io/src/processing/io/*.java \
41-
$PROCESSING_LIB_PATH/net/src/processing/net/*.java \
42-
$PROCESSING_LIB_PATH/serial/src/processing/serial/*.java \
43-
$PROCESSING_LIB_PATH/../../../processing-video/src/processing/video/*.java \
44-
$PROCESSING_LIB_PATH/../../../processing-sound/src/processing/sound/*.java \
75+
$FOLDERS \
4576
-noisy

0 commit comments

Comments
 (0)