From ebb25d8a4503f93c0530e8478cdf948edfa95f2d Mon Sep 17 00:00:00 2001 From: Casey Reas Date: Tue, 4 Sep 2012 00:27:00 +0000 Subject: [PATCH] Moving some documentation tags about of PApplet --- core/src/processing/core/PApplet.java | 22 ------------------ core/src/processing/core/PGraphics.java | 6 ++++- .../CreateGraphics/CreateGraphics.pde | 2 +- .../PolygonPShape/PolygonPShape.pde | 2 +- .../PrimitivePShape/PrimitivePShape.pde | 4 ++-- java/keywords.txt | 23 +++++++++---------- 6 files changed, 20 insertions(+), 39 deletions(-) diff --git a/core/src/processing/core/PApplet.java b/core/src/processing/core/PApplet.java index 36844bb80..36e3574f7 100644 --- a/core/src/processing/core/PApplet.java +++ b/core/src/processing/core/PApplet.java @@ -654,13 +654,8 @@ public class PApplet extends Applet public boolean focused = false; /** - * ( begin auto-generated from online.xml ) - * * Confirms if a Processing program is running inside a web browser. This * variable is "true" if the program is online and "false" if not. - * - * ( end auto-generated ) - * @webref environment */ @Deprecated public boolean online = false; @@ -3085,19 +3080,12 @@ public class PApplet extends Applet /** - * ( begin auto-generated from param.xml ) - * * Reads the value of a param. Values are always read as a String so if you * want them to be an integer or other datatype they must be converted. The * param() function will only work in a web browser. The function * should be called inside setup(), otherwise the applet may not yet * be initialized and connected to its parent web browser. * - * ( end auto-generated ) - * - * @webref input:web - * @usage Web - * * @param name name of the param to read * @deprecated no more applet support */ @@ -3113,21 +3101,11 @@ public class PApplet extends Applet /** - * ( begin auto-generated from status.xml ) - * - * Displays message in the browser's status area. This is the text area in - * the lower left corner of the browser. The status() function will - * only work when the Processing program is running in a web browser. - * - * ( end auto-generated ) *

Advanced

* Show status in the status bar of a web browser, or in the * System.out console. Eventually this might show status in the * p5 environment itself, rather than relying on the console. * - * @webref input:web - * @usage Web - * @param value any valid String * @deprecated no more applet support */ public void status(String value) { diff --git a/core/src/processing/core/PGraphics.java b/core/src/processing/core/PGraphics.java index c12c1c456..332f07b06 100644 --- a/core/src/processing/core/PGraphics.java +++ b/core/src/processing/core/PGraphics.java @@ -3278,7 +3278,11 @@ public class PGraphics extends PImage implements PConstants { public void smooth() { smooth = true; } - + + /** + * + * @param level either 2, 4, or 8 + */ public void smooth(int level) { smooth = true; } diff --git a/java/examples/Basics/Structure/CreateGraphics/CreateGraphics.pde b/java/examples/Basics/Structure/CreateGraphics/CreateGraphics.pde index 0ecb9f146..fe98f68dc 100644 --- a/java/examples/Basics/Structure/CreateGraphics/CreateGraphics.pde +++ b/java/examples/Basics/Structure/CreateGraphics/CreateGraphics.pde @@ -12,7 +12,7 @@ PGraphics pg; void setup() { size(640, 360); - pg = createGraphics(400, 200, P2D); + pg = createGraphics(400, 200); } void draw() { diff --git a/java/examples/Topics/Create Shapes/PolygonPShape/PolygonPShape.pde b/java/examples/Topics/Create Shapes/PolygonPShape/PolygonPShape.pde index b4a88a477..4a9a337f5 100644 --- a/java/examples/Topics/Create Shapes/PolygonPShape/PolygonPShape.pde +++ b/java/examples/Topics/Create Shapes/PolygonPShape/PolygonPShape.pde @@ -9,7 +9,7 @@ PShape star; void setup() { - size(640, 360,P2D); + size(640, 360, P2D); smooth(); // First create the shape star = createShape(); diff --git a/java/examples/Topics/Create Shapes/PrimitivePShape/PrimitivePShape.pde b/java/examples/Topics/Create Shapes/PrimitivePShape/PrimitivePShape.pde index ab45101a2..062a3e454 100644 --- a/java/examples/Topics/Create Shapes/PrimitivePShape/PrimitivePShape.pde +++ b/java/examples/Topics/Create Shapes/PrimitivePShape/PrimitivePShape.pde @@ -13,7 +13,7 @@ void setup() { smooth(); // Creating the PShape as an ellipse // The corner is -50,-50 so that the center is at 0,0 - circle = createShape(RECT,-50,-25,100,50); + circle = createShape(RECT, -50, -25, 100, 50); } void draw() { @@ -21,7 +21,7 @@ void draw() { // We can dynamically set the stroke and fill of the shape circle.stroke(255); circle.strokeWeight(4); - circle.fill(map(mouseX,0,width,0,255)); + circle.fill(map(mouseX, 0, width, 0, 255)); // We can use translate to move the PShape translate(mouseX, mouseY); // Drawing the PShape diff --git a/java/keywords.txt b/java/keywords.txt index 7c9229ed4..e7b65b3e7 100644 --- a/java/keywords.txt +++ b/java/keywords.txt @@ -230,8 +230,7 @@ void KEYWORD1 void volatile KEYWORD1 while KEYWORD1 while - -# Depricated API +# Deprecated API arraycopy KEYWORD2 arrayCopy_ openStream KEYWORD2 openStream_ @@ -246,7 +245,7 @@ boolean KEYWORD2 booleanconvert_ byte KEYWORD2 byteconvert_ cache KEYWORD2 char KEYWORD2 charconvert_ -color KEYWORD1 color_datatype +color KEYWORD1 color_datatype start KEYWORD2 stop KEYWORD2 breakShape KEYWORD2 @@ -625,13 +624,13 @@ unhex KEYWORD2 unhex_ updatePixels KEYWORD2 updatePixels_ vertex KEYWORD2 vertex_ width KEYWORD5 width -XMLElement KEYWORD2 XMLElement_ -getChild KEYWORD3 XMLElement_getChild_ -getChildCount KEYWORD3 XMLElement_getChildCount_ -getChildren KEYWORD3 XMLElement_getChildren_ -getContent KEYWORD3 XMLElement_getContent_ -getFloat KEYWORD3 XMLElement_getFloat_ -getInt KEYWORD3 XMLElement_getInt_ -getName KEYWORD3 XMLElement_getName_ -getString KEYWORD3 XMLElement_getString_ +XMLElement KEYWORD2 XML_ +getChild KEYWORD3 XML_getChild_ +getChildCount KEYWORD3 XML_getChildCount_ +getChildren KEYWORD3 XML_getChildren_ +getContent KEYWORD3 XML_getContent_ +getFloat KEYWORD3 XML_getFloat_ +getInt KEYWORD3 XML_getInt_ +getName KEYWORD3 XML_getName_ +getString KEYWORD3 XML_getString_ year KEYWORD2 year_