processing / processing-video

GStreamer-based video library for Processing
274 stars 130 forks source link

Changing comments to fit with the new reference system #184

Closed Anadroid closed 3 years ago

Anadroid commented 3 years ago

This PR adjusts the comments in the java files to fit with the new reference system created for the new processing website. You can see details for the new reference system here.

Changes are made to all the comments that have @webref in them. Since captureEvent and movieEvent are not found in the repo, and these methods should appear on the video reference page on the processing website, we have created individual .json files to make it possible.. These files are directly made in the website repo. The content for these files corresponds to the old .xml files found here.

For the constructors in the Capture class, we have adjusted the format to the one found in the main Processing source where the @param is explicitly written only in the constructors in which those parameters first appear.

Let us know if you have any questions!