Skip to content

Processing Reference Notes

Jump to bottom Edit New page
Casey Reas edited this page Oct 21, 2015 · 8 revisions

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\

*** XML Files

The descriptions and examples for the reference are stored in XML files. These XML files used to contain the entire reference and we moved to the split Javadoc/XML merge system later.

Add a custom footer
Add a custom sidebar
Clone this wiki locally