-
-
Notifications
You must be signed in to change notification settings - Fork 179
Processing Reference Notes
This file is incomplete, it was started on 14 October 2015 as a start to documenting our complicated Reference generation code
To build the Reference files, it's necessary to have three repositories checked out within the same folder:
- /processing/processing/
- /processing/processing-docs/
- /processing/processing-sound/
The Reference HTML files are created by taking Javadoc and custom Javadoc-style elements from JAVA files and combining this with information from hand-edited XML files. The XML files contain the descriptions and the examples. The JAVA files contain the parameters, description of parameters, the category for the Index, the related functions, and more.
The script to build the Reference HTML files are in the java-generate folder. Run the processingrefBuild.sh file inside java-generate\ReferenceGenerator\
The descriptions and examples for the Reference are stored in XML files located here. These XML files used to contain the entire reference and we moved to the split Javadoc/XML merge system later. Some (many) parts of the Java language are included in the Processing Reference and these are built entirely from the XML files. These files are in the include folder located here.
The Processing Reference pulls information from the Javadoc notation in the source code and the Reference has a few custom tags in the Javadoc style that need to be added for the Reference to build correctly.