diff --git a/core/src/processing/core/PApplet.java b/core/src/processing/core/PApplet.java index 572c614b9..5fb011965 100644 --- a/core/src/processing/core/PApplet.java +++ b/core/src/processing/core/PApplet.java @@ -5530,9 +5530,9 @@ public class PApplet implements PConstants { *
* If the file is not available or an error occurs, null will be * returned and an error message will be printed to the console. The error - * message does not halt the program, however the null value may cause a + * message does not halt the program, however the null value may cause a * NullPointerException if your code does not check whether the value returned - * is null.
+ * is null.
*
* The extension parameter is used to determine the image type in cases * where the image filename does not end with a proper extension. Specify the @@ -5721,13 +5721,13 @@ public class PApplet implements PConstants { /** * Takes a String, parses its contents, and returns an XML object. If the - * String does not contain XML data or cannot be parsed, a null value is + * String does not contain XML data or cannot be parsed, a null value is * returned.
*
* parseXML() is most useful when pulling data dynamically, such as * from third-party APIs. Normally, API results would be saved to a String, * and then can be converted to a structured XML object using - * parseXML(). Be sure to check if null is returned before performing + * parseXML(). Be sure to check if null is returned before performing * operations on the new XML object, in case the String content could not be * parsed.
*
@@ -6185,9 +6185,9 @@ public class PApplet implements PConstants { *
* If the file is not available or an error occurs, null will be * returned and an error message will be printed to the console. The error - * message does not halt the program, however the null value may cause a + * message does not halt the program, however the null value may cause a * NullPointerException if your code does not check whether the value returned - * is null.
+ * is null.
*
* Use createFont() (instead of loadFont()) to enable vector * data to be used with the default renderer setting. This can be helpful when @@ -6318,7 +6318,7 @@ public class PApplet implements PConstants { /** * Open a platform-specific file chooser dialog to select a file for input. * After the selection is made, the selected File will be passed to the - * 'callback' function. If the dialog is closed or canceled, null will be sent + * 'callback' function. If the dialog is closed or canceled, null will be sent * to the function, so that the program is not waiting for additional input. * The callback is necessary because of how threading works. * @@ -6384,7 +6384,7 @@ public class PApplet implements PConstants { /** * Opens a platform-specific file chooser dialog to select a file for output. * After the selection is made, the selected File will be passed to the - * 'callback' function. If the dialog is closed or canceled, null will be sent + * 'callback' function. If the dialog is closed or canceled, null will be sent * to the function, so that the program is not waiting for additional input. * The callback is necessary because of how threading works. * @@ -6912,7 +6912,7 @@ public class PApplet implements PConstants { * - The full path to a file to be opened locally (when running as an * application)
*
- * If the requested item doesn't exist, null is returned. If not online, + * If the requested item doesn't exist, null is returned. If not online, * this will also check to see if the user is asking for a file whose name * isn't properly capitalized. If capitalization is different, an error * will be printed to the console. This helps prevent issues that appear @@ -7183,9 +7183,9 @@ public class PApplet implements PConstants { *
* If the file is not available or an error occurs, null will be * returned and an error message will be printed to the console. The error - * message does not halt the program, however the null value may cause a + * message does not halt the program, however the null value may cause a * NullPointerException if your code does not check whether the value returned - * is null.
+ * is null.
* * @webref input:files * @webBrief Reads the contents of a file or url and places it in a byte @@ -7401,9 +7401,9 @@ public class PApplet implements PConstants { *
* If the file is not available or an error occurs, null will be * returned and an error message will be printed to the console. The error - * message does not halt the program, however the null value may cause a + * message does not halt the program, however the null value may cause a * NullPointerException if your code does not check whether the value returned - * is null.
+ * is null.
*
* Starting with Processing release 0134, all files loaded and saved by the * Processing API use UTF-8 encoding. In previous releases, the default @@ -9149,12 +9149,12 @@ public class PApplet implements PConstants { * * This function is used to apply a regular expression to a piece of text, and * return matching groups (elements found inside parentheses) as a String - * array. If there are no matches, a null value will be returned. If no groups + * array. If there are no matches, a null value will be returned. If no groups * are specified in the regular expression, but the sequence matches, an array * of length 1 (with the matched text as the first element of the array) will * be returned.
*
- * To use the function, first check to see if the result is null. If the + * To use the function, first check to see if the result is null. If the * result is null, then the sequence did not match at all. If the sequence did * match, an array is returned.
*
@@ -9173,7 +9173,7 @@ public class PApplet implements PConstants { * @webref data:string_functions * @webBrief The match() function is used to apply a regular expression to a * piece of text, and return matching groups (elements found inside - * parentheses) as a String array. No match will return null. + * parentheses) as a String array. No match will return null. * @param str * the String to be searched * @param regexp @@ -9203,12 +9203,12 @@ public class PApplet implements PConstants { * * This function is used to apply a regular expression to a piece of text, and * return a list of matching groups (elements found inside parentheses) as a - * two-dimensional String array. If there are no matches, a null value will be + * two-dimensional String array. If there are no matches, a null value will be * returned. If no groups are specified in the regular expression, but the * sequence matches, a two dimensional array is still returned, but the second * dimension is only of length one.
*
- * To use the function, first check to see if the result is null. If the + * To use the function, first check to see if the result is null. If the * result is null, then the sequence did not match at all. If the sequence did * match, a 2D array is returned.
*
@@ -11524,9 +11524,9 @@ public class PApplet implements PConstants { *
* If the file is not available or an error occurs, null will * be returned and an error message will be printed to the console. - * The error message does not halt the program, however the null value + * The error message does not halt the program, however the null value * may cause a NullPointerException if your code does not check whether - * the value returned is null.
+ * the value returned is null.
* * @webref shape * @webBrief Loads geometry into a variable of type PShape. @@ -11615,7 +11615,7 @@ public class PApplet implements PConstants { * be returned and an error message will be printed to the console. * The error message does not halt the program, however the null * value may cause a NullPointerException if your code does not check - * whether the value returned is null.
+ * whether the value returned is null.
* * * @webref rendering:shaders diff --git a/core/src/processing/data/FloatDict.java b/core/src/processing/data/FloatDict.java index 3dbd639a7..6d1cd693e 100644 --- a/core/src/processing/data/FloatDict.java +++ b/core/src/processing/data/FloatDict.java @@ -9,11 +9,11 @@ import processing.core.PApplet; /** - * A simple class to use a String as a lookup for an float value. String "keys" + * A simple class to use a String as a lookup for a float value. String "keys" * are associated with floating-point values. * * @webref data:composite - * @webBrief A simple table class to use a String as a lookup for an float + * @webBrief A simple table class to use a String as a lookup for a float * value. * @see IntDict * @see StringDict @@ -415,7 +415,7 @@ public class FloatDict { /** - * Add to a value. If the key does not exist, an new pair is initialized with + * Add to a value. If the key does not exist, a new pair is initialized with * the value supplied. * * @webref floatdict:method diff --git a/core/src/processing/data/FloatList.java b/core/src/processing/data/FloatList.java index 2816c2662..d45f48321 100644 --- a/core/src/processing/data/FloatList.java +++ b/core/src/processing/data/FloatList.java @@ -11,11 +11,11 @@ import processing.core.PApplet; /** * Helper class for a list of floats. Lists are designed to have some of the - * features of ArrayLists, but to maintain the simplicity and efficiency of + * features of ArrayLists, but to maintain the simplicity and efficiency of * working with arrays. * - * Functions like sort() and shuffle() always act on the list itself. To get - * a sorted copy, use list.copy().sort(). + * Functions like sort() and shuffle() always act on the list itself. To get + * a sorted copy, use list.copy().sort(). * * @webref data:composite * @webBrief Helper class for a list of floats. diff --git a/core/src/processing/data/IntDict.java b/core/src/processing/data/IntDict.java index 78e594f5b..2dab5bbb2 100644 --- a/core/src/processing/data/IntDict.java +++ b/core/src/processing/data/IntDict.java @@ -9,11 +9,11 @@ import processing.core.PApplet; /** - * A simple class to use a String as a lookup for an int value. String "keys" are + * A simple class to use a String as a lookup for an int value. String "keys" are * associated with integer values. * * @webref data:composite - * @webBrief A simple class to use a String as a lookup for an int value. + * @webBrief A simple class to use a String as a lookup for an int value. * @see FloatDict * @see StringDict */ diff --git a/core/src/processing/data/IntList.java b/core/src/processing/data/IntList.java index 51af0ecb5..b63d5085c 100644 --- a/core/src/processing/data/IntList.java +++ b/core/src/processing/data/IntList.java @@ -16,11 +16,11 @@ import processing.core.PApplet; /** * Helper class for a list of ints. Lists are designed to have some of the - * features of ArrayLists, but to maintain the simplicity and efficiency of + * features of ArrayLists, but to maintain the simplicity and efficiency of * working with arrays. * - * Functions like sort() and shuffle() always act on the list itself. To get - * a sorted copy, use list.copy().sort(). + * Functions like sort() and shuffle() always act on the list itself. To get + * a sorted copy, use list.copy().sort(). * * @webref data:composite * @webBrief Helper class for a list of ints. diff --git a/core/src/processing/data/JSONArray.java b/core/src/processing/data/JSONArray.java index 32919e672..173433b5e 100644 --- a/core/src/processing/data/JSONArray.java +++ b/core/src/processing/data/JSONArray.java @@ -279,7 +279,7 @@ public class JSONArray { /** - * Gets the String value associated with the specified index. + * Gets the String value associated with the specified index. * * @webref jsonarray:method * @webBrief Gets the String value associated with an index @@ -562,11 +562,11 @@ public class JSONArray { /** - * Returns the entire JSONArray as an array of Strings. - * (All values in the array must be of the String type.) + * Returns the entire JSONArray as an array of Strings. + * (All values in the array must be of the String type.) * * @webref jsonarray:method - * @webBrief Returns the entire JSONArray as an array of Strings + * @webBrief Returns the entire JSONArray as an array of Strings * @see JSONArray#getIntArray() */ public String[] getStringArray() { @@ -579,11 +579,11 @@ public class JSONArray { /** - * Returns the entire JSONArray as an array of ints. + * Returns the entire JSONArray as an array of ints. * (All values in the array must be of the int type.) * * @webref jsonarray:method - * @webBrief Returns the entire JSONArray as an array of ints + * @webBrief Returns the entire JSONArray as an array of ints * @see JSONArray#getStringArray() */ public int[] getIntArray() { @@ -702,8 +702,8 @@ public class JSONArray { /** * Appends a new value to the JSONArray, increasing the array's length - * by one. New values may be of the following types: int, float, String, - * boolean, JSONObject, or JSONArray. + * by one. New values may be of the following types: int, float, String, + * boolean, JSONObject, or JSONArray. * * @webref jsonarray:method * @webBrief Appends a value, increasing the array's length by one @@ -1080,7 +1080,7 @@ public class JSONArray { /** * Removes the element from a JSONArray in the specified index position. - * Returns either the value associated with the given index, or null, if there + * Returns either the value associated with the given index, or null, if there * is no value. * * @webref jsonarray:method diff --git a/core/src/processing/data/JSONObject.java b/core/src/processing/data/JSONObject.java index f5413b3ae..457085e5f 100644 --- a/core/src/processing/data/JSONObject.java +++ b/core/src/processing/data/JSONObject.java @@ -52,7 +52,7 @@ import processing.core.PApplet; /** * A JSONObject stores JSON data with multiple name/value pairs. Values - * can be numeric, Strings, booleans, other JSONObjects or + * can be numeric, Strings, booleans, other JSONObjects or * JSONArrays, or null. JSONObject and JSONArray objects * are quite similar and share most of the same methods; the primary difference * is that the latter stores an array of JSON objects, while the former @@ -567,7 +567,7 @@ public class JSONObject { /** - * Gets the String value associated with the specified key. + * Gets the String value associated with the specified key. * * @webref jsonobject:method * @webBrief Gets the String value associated with the specified key diff --git a/core/src/processing/data/LongList.java b/core/src/processing/data/LongList.java index 1598753d7..2c818526c 100644 --- a/core/src/processing/data/LongList.java +++ b/core/src/processing/data/LongList.java @@ -710,7 +710,7 @@ public class LongList implements Iterable { /** * Randomize the order of the list elements. Note that this does not - * obey the randomSeed() function in PApplet. + * obey the randomSeed() function in PApplet. * * @webref intlist:method * @webBrief Randomize the order of the list elements diff --git a/core/src/processing/data/StringDict.java b/core/src/processing/data/StringDict.java index 97e2e4d72..6f4d8f4a4 100644 --- a/core/src/processing/data/StringDict.java +++ b/core/src/processing/data/StringDict.java @@ -9,8 +9,8 @@ import processing.core.PApplet; /** - * A simple class to use a String as a lookup for an String value. String "keys" - * are associated with String values. + * A simple class to use a String as a lookup for a String value. String "keys" + * are associated with String values. * * @webref data:composite * @webBrief A simple class to use a String as a lookup for an String value diff --git a/core/src/processing/data/StringList.java b/core/src/processing/data/StringList.java index f69c1a7ea..93bafd46c 100644 --- a/core/src/processing/data/StringList.java +++ b/core/src/processing/data/StringList.java @@ -9,12 +9,12 @@ import java.util.Random; import processing.core.PApplet; /** - * Helper class for a list of Strings. Lists are designed to have some of the - * features of ArrayLists, but to maintain the simplicity and efficiency of + * Helper class for a list of Strings. Lists are designed to have some of the + * features of ArrayLists, but to maintain the simplicity and efficiency of * working with arrays. * - * Functions like sort() and shuffle() always act on the list itself. To get - * a sorted copy, use list.copy().sort(). + * Functions like sort() and shuffle() always act on the list itself. To get + * a sorted copy, use list.copy().sort(). * * @webref data:composite * @webBrief Helper class for a list of Strings. @@ -149,7 +149,7 @@ public class StringList implements Iterable { /** * Set the entry at a particular index. If the index is past the length of * the list, it'll expand the list to accommodate, and fill the intermediate - * entries with "null". + * entries with null. * * @webref stringlist:method * @webBrief Set an entry at a particular index diff --git a/core/src/processing/data/Table.java b/core/src/processing/data/Table.java index 505be67ff..3b0047b6e 100644 --- a/core/src/processing/data/Table.java +++ b/core/src/processing/data/Table.java @@ -1806,9 +1806,9 @@ public class Table { * Use addColumn() to add a new column to a Table object. * Typically, you will want to specify a title, so the column may be easily * referenced later by name. (If no title is specified, the new column's title - * will be null.) A column type may also be specified, in which case all values - * stored in this column must be of the same type (e.g., Table.INT or - * Table.FLOAT). If no type is specified, the default type of STRING is used. + * will be null.) A column type may also be specified, in which case all values + * stored in this column must be of the same type (e.g., Table.INT or + * Table.FLOAT). If no type is specified, the default type of STRING is used. * * @webref table:method * @webBrief Adds a new column to a table @@ -1886,7 +1886,7 @@ public class Table { /** * Use removeColumn() to remove an existing column from a Table * object. The column to be removed may be identified by either its title (a - * String) or its index value (an int). removeColumn(0) would remove the + * String) or its index value (an int). removeColumn(0) would remove the * first column, removeColumn(1) would remove the second column, and so * on. * @@ -3609,7 +3609,7 @@ public class Table { } /** - * Retrieves all values in the specified column, and returns them as a String + * Retrieves all values in the specified column, and returns them as a String * array. The column may be specified by either its ID or title. * * @webref table:method diff --git a/core/src/processing/data/TableRow.java b/core/src/processing/data/TableRow.java index 45c7816e7..ba289c8b9 100644 --- a/core/src/processing/data/TableRow.java +++ b/core/src/processing/data/TableRow.java @@ -99,7 +99,7 @@ public interface TableRow { public double getDouble(String columnName); /** - * Stores a String value in the TableRow's specified column. The column + * Stores a String value in the TableRow's specified column. The column * may be specified by either its ID or title. * * @webref tablerow:method @@ -116,7 +116,7 @@ public interface TableRow { public void setString(String columnName, String value); /** - * Stores an integer value in the TableRow's specified column. The column + * Stores an integer value in the TableRow's specified column. The column * may be specified by either its ID or title. * * @webref tablerow:method @@ -148,7 +148,7 @@ public interface TableRow { public void setLong(String columnName, long value); /** - * Stores a float value in the TableRow's specified column. The column + * Stores a float value in the TableRow's specified column. The column * may be specified by either its ID or title. * * @webref tablerow:method diff --git a/core/src/processing/data/XML.java b/core/src/processing/data/XML.java index f83451594..46504fde3 100644 --- a/core/src/processing/data/XML.java +++ b/core/src/processing/data/XML.java @@ -41,16 +41,16 @@ import processing.core.PApplet; /** - * XML is a representation of an XML object, able to parse XML code. Use + * XML is a representation of an XML object, able to parse XML code. Use * loadXML() to load external XML files and create XML * objects.
*
* Only files encoded as UTF-8 (or plain ASCII) are parsed properly; the - * encoding parameter inside XML files is ignored. + * encoding parameter inside XML files is ignored. * * @webref data:composite * @webBrief This is the base class used for the Processing XML library, - * representing a single node of an XML tree. + * representing a single node of an XML tree. * @see PApplet#loadXML(String) * @see PApplet#parseXML(String) * @see PApplet#saveXML(XML, String) @@ -253,10 +253,10 @@ public class XML implements Serializable { /** - * Converts String content to an XML object + * Converts String content to an XML object * * @webref xml:method - * @webBrief Converts String content to an XML object + * @webBrief Converts String content to an XML object * @param data the content to be parsed as XML * @return an XML object, or null * @throws SAXException @@ -305,7 +305,7 @@ public class XML implements Serializable { /** - * Gets a copy of the element's parent. Returns the parent as another XML object. + * Gets a copy of the element's parent. Returns the parent as another XML object. * * @webref xml:method * @webBrief Gets a copy of the element's parent @@ -323,7 +323,7 @@ public class XML implements Serializable { /** - * Gets the element's full name, which is returned as a String. + * Gets the element's full name, which is returned as a String. * * @webref xml:method * @webBrief Gets the element's full name @@ -335,7 +335,7 @@ public class XML implements Serializable { } /** - * Sets the element's name, which is specified as a String. + * Sets the element's name, which is specified as a String. * * @webref xml:method * @webBrief Sets the element's name @@ -388,7 +388,7 @@ public class XML implements Serializable { /** - * Checks whether or not the element has any children, and returns the result as a boolean. + * Checks whether or not the element has any children, and returns the result as a boolean. * * @webref xml:method * @webBrief Checks whether or not an element has any children @@ -401,7 +401,7 @@ public class XML implements Serializable { /** * Get the names of all of the element's children, and returns the names as an - * array of Strings. This is the same as looping through and calling getName() + * array of Strings. This is the same as looping through and calling getName() * on each child element individually. * * @webref xml:method @@ -427,7 +427,7 @@ public class XML implements Serializable { /** - * Returns all of the element's children as an array of XML objects. When + * Returns all of the element's children as an array of XML objects. When * the name parameter is specified, then it will return all children * that match that name or path. The path is a series of elements and * sub-elements, separated by slashes. @@ -572,10 +572,10 @@ public class XML implements Serializable { /** * Appends a new child to the element. The child can be specified with either a - * String, which will be used as the new tag's name, or as a reference to an - * existing XML object.
+ * String, which will be used as the new tag's name, or as a reference to an + * existing XML object.
*
- * A reference to the newly created child is returned as an XML object. + * A reference to the newly created child is returned as an XML object. * * @webref xml:method * @webBrief Appends a new child to the element @@ -695,7 +695,7 @@ public class XML implements Serializable { /** - * Counts the specified element's number of attributes, returned as an int. + * Counts the specified element's number of attributes, returned as an int. * * @webref xml:method * @webBrief Counts the specified element's number of attributes @@ -706,7 +706,7 @@ public class XML implements Serializable { /** - * Gets all of the specified element's attributes, and returns them as an array of Strings. + * Gets all of the specified element's attributes, and returns them as an array of Strings. * * @webref xml:method * @webBrief Returns a list of names of all attributes as an array @@ -722,7 +722,7 @@ public class XML implements Serializable { /** * Checks whether or not an element has the specified attribute. The attribute - * must be specified as a String, and a boolean is returned. + * must be specified as a String, and a boolean is returned. * * @webref xml:method * @webBrief Checks whether or not an element has the specified attribute @@ -757,13 +757,13 @@ public class XML implements Serializable { /** - * Returns an attribute value of the element as a String. If the defaultValue + * Returns an attribute value of the element as a String. If the defaultValue * parameter is specified and the attribute doesn't exist, then defaultValue * is returned. If no defaultValue is specified and the attribute doesn't - * exist, null is returned. + * exist, null is returned. * * @webref xml:method - * @webBrief Gets the content of an attribute as a String + * @webBrief Gets the content of an attribute as a String */ public String getString(String name) { return getString(name, null); @@ -783,11 +783,11 @@ public class XML implements Serializable { /** - * Sets the content of an element's attribute as a String. The first String + * Sets the content of an element's attribute as a String. The first String * specifies the attribute name, while the second specifies the new content. * * @webref xml:method - * @webBrief Sets the content of an attribute as a String + * @webBrief Sets the content of an attribute as a String */ public void setString(String name, String value) { ((Element) node).setAttribute(name, value); @@ -795,13 +795,13 @@ public class XML implements Serializable { /** - * Returns an attribute value of the element as an int. If the defaultValue + * Returns an attribute value of the element as an int. If the defaultValue * parameter is specified and the attribute doesn't exist, then defaultValue * is returned. If no defaultValue is specified and the attribute doesn't * exist, the value 0 is returned. * * @webref xml:method - * @webBrief Gets the content of an attribute as an int + * @webBrief Gets the content of an attribute as an int */ public int getInt(String name) { return getInt(name, 0); @@ -809,11 +809,11 @@ public class XML implements Serializable { /** - * Sets the content of an element's attribute as an int. A String specifies + * Sets the content of an element's attribute as an int. A String specifies * the attribute name, while the int specifies the new content. * * @webref xml:method - * @webBrief Sets the content of an attribute as an int + * @webBrief Sets the content of an attribute as an int */ public void setInt(String name, int value) { setString(name, String.valueOf(value)); @@ -834,10 +834,10 @@ public class XML implements Serializable { /** - * Sets the content of an element as an int + * Sets the content of an element as an int * * @webref xml:method - * @webBrief Sets the content of an element as an int + * @webBrief Sets the content of an element as an int */ public void setLong(String name, long value) { setString(name, String.valueOf(value)); @@ -864,7 +864,7 @@ public class XML implements Serializable { * and the attribute doesn't exist, the value 0.0 is returned. * * @webref xml:method - * @webBrief Gets the content of an attribute as a float + * @webBrief Gets the content of an attribute as a float */ public float getFloat(String name) { return getFloat(name, 0); @@ -885,11 +885,11 @@ public class XML implements Serializable { /** - * Sets the content of an element's attribute as a float. A String specifies - * the attribute name, while the float specifies the new content. + * Sets the content of an element's attribute as a float. A String specifies + * the attribute name, while the float specifies the new content. * * @webref xml:method - * @webBrief Sets the content of an attribute as a float + * @webBrief Sets the content of an attribute as a float */ public void setFloat(String name, float value) { setString(name, String.valueOf(value)); @@ -941,11 +941,11 @@ public class XML implements Serializable { /** - * Returns the content of an element as an int. If there is no such content, + * Returns the content of an element as an int. If there is no such content, * either null or the provided default value is returned. * * @webref xml:method - * @webBrief Gets the content of an element as an int + * @webBrief Gets the content of an element as an int * @return the content. * @see XML#getContent() * @see XML#getFloatContent() @@ -964,11 +964,11 @@ public class XML implements Serializable { /** - * Returns the content of an element as a float. If there is no such content, + * Returns the content of an element as a float. If there is no such content, * either null or the provided default value is returned. * * @webref xml:method - * @webBrief Gets the content of an element as a float + * @webBrief Gets the content of an element as a float * @return the content. * @see XML#getContent() * @see XML#getIntContent() @@ -1019,7 +1019,7 @@ public class XML implements Serializable { /** - * Sets the element's content, which is specified as a String. + * Sets the element's content, which is specified as a String. * * @webref xml:method * @webBrief Sets the content of an element @@ -1050,19 +1050,19 @@ public class XML implements Serializable { /** - * Takes an XML object and converts it to a String, formatting its content as + * Takes an XML object and converts it to a String, formatting its content as * specified with the indent parameter.
*
* If indent is set to -1, then the String is returned with no line breaks, no - * indentation, and no XML declaration.
+ * indentation, and no XML declaration.
*
- * If indent is set to 0 or greater, then the String is returned with line + * If indent is set to 0 or greater, then the String is returned with line * breaks, and the specified number of spaces as indent values. Meaning, there * will be no indentation if 0 is specified, or each indent will be replaced * with the corresponding number of spaces: 1, 2, 3, and so on. * * @webref xml:method - * @webBrief Formats XML data as a String + * @webBrief Formats XML data as a String * @param indent -1 for a single line (and no declaration), >= 0 for indents and * newlines * @return the content @@ -1204,13 +1204,13 @@ public class XML implements Serializable { /** - * Takes an XML object and converts it to a String, using default formatting + * Takes an XML object and converts it to a String, using default formatting * rules (includes an XML declaration, line breaks, and two spaces for indents). * These are the same formatting rules used by println() when printing an - * XML object. This method produces the same results as using format(2). + * XML object. This method produces the same results as using format(2). * * @webref xml:method - * @webBrief Gets XML data as a String using default formatting + * @webBrief Gets XML data as a String using default formatting * @return the content * @see XML#format(int) */ diff --git a/core/src/processing/opengl/PShader.java b/core/src/processing/opengl/PShader.java index 0f7c08185..e7242de5a 100644 --- a/core/src/processing/opengl/PShader.java +++ b/core/src/processing/opengl/PShader.java @@ -37,7 +37,7 @@ import java.util.HashMap; * fragment shader. It's compatible with the P2D and P3D renderers, but not with * the default renderer. Use the loadShader() function to load your * shader code. [Note: It's strongly encouraged to use loadShader() to - * create a PShader object, rather than calling the PShader constructor + * create a PShader object, rather than calling the PShader constructor * manually.] * * @webref rendering:shaders diff --git a/java/libraries/io/src/processing/io/GPIO.java b/java/libraries/io/src/processing/io/GPIO.java index 6dbea0ad3..315f257f7 100644 --- a/java/libraries/io/src/processing/io/GPIO.java +++ b/java/libraries/io/src/processing/io/GPIO.java @@ -94,16 +94,16 @@ public class GPIO { /** * Calls a function when the value of an input pin changes
*
- * The sketch method provided must accept a single integer (int) parameter, which is the + * The sketch method provided must accept a single integer (int) parameter, which is the * number of the GPIO pin that the interrupt occured on. As this method might be called * at any time, including when drawing to the display window isn't permitted, it is best - * to only set simple variables that are being responded to in the next draw() call, as + * to only set simple variables that are being responded to in the next draw() call, as * shown above. Calling functions of the Hardware I/O library at this point is certainly * possible.
*
- * The mode parameter determines when the function will be called: GPIO.FALLING occurs - * when the level changes from high to low, GPIO.RISING when the level changes from low - * to high, and GPIO.CHANGE when either occurs. + * The mode parameter determines when the function will be called: GPIO.FALLING occurs + * when the level changes from high to low, GPIO.RISING when the level changes from low + * to high, and GPIO.CHANGE when either occurs. * * @param pin GPIO pin * @param parent typically use "this" @@ -333,7 +333,7 @@ public class GPIO { * Allows interrupts to happen
*
* You can use noInterrupts() - * and interrupts() in tandem to make sure no interrupts are occuring + * and interrupts() in tandem to make sure no interrupts are occuring * while your sketch is doing a particular task. By default, interrupts * are enabled. * @@ -351,7 +351,7 @@ public class GPIO { /** * Prevents interrupts from happpening
*
- * You can use noInterrupts() and interrupts() + * You can use noInterrupts() and interrupts() * in tandem to make sure no interrupts are occuring while your sketch is doing a * particular task.
* br/> @@ -529,9 +529,9 @@ public class GPIO { /** * Waits for the value of an input pin to change
*
- * The mode parameter determines when the function will return: GPIO.FALLING occurs - * when the level changes from high to low, GPIO.RISING when the level changes from - * low to high, and GPIO.CHANGE when either occurs.
+ * The mode parameter determines when the function will return: GPIO.FALLING occurs + * when the level changes from high to low, GPIO.RISING when the level changes from + * low to high, and GPIO.CHANGE when either occurs.
*
* The optional timeout parameter determines how many milliseconds the function will * wait at the most. If the value of the input pin hasn't changed at this point, an @@ -550,9 +550,9 @@ public class GPIO { /** * Waits for the value of an input pin to change
*
- * The mode parameter determines when the function will return: GPIO.FALLING occurs - * when the level changes from high to low, GPIO.RISING when the level changes from - * low to high, and GPIO.CHANGE when either occurs.
+ * The mode parameter determines when the function will return: GPIO.FALLING occurs + * when the level changes from high to low, GPIO.RISING when the level changes from + * low to high, and GPIO.CHANGE when either occurs.
*
* The optional timeout parameter determines how many milliseconds the function will * wait at the most. If the value of the input pin hasn't changed at this point, an diff --git a/java/libraries/io/src/processing/io/I2C.java b/java/libraries/io/src/processing/io/I2C.java index c65ecc5c9..d165cd327 100644 --- a/java/libraries/io/src/processing/io/I2C.java +++ b/java/libraries/io/src/processing/io/I2C.java @@ -150,7 +150,7 @@ public class I2C { *
* This executes any queued writes. Read() * implicitly ends the current transmission as well, hence calling - * endTransmission() afterwards is not necessary. + * endTransmission() afterwards is not necessary. * * @see beginTransmission * @see write @@ -212,10 +212,10 @@ public class I2C { /** * Read bytes from the attached device
*
- * You must call beginTransmission() before calling this function. This function + * You must call beginTransmission() before calling this function. This function * also ends the current transmission and sends any data that was queued using - * write() before. It is not necessary to call - * endTransmission() after read(). + * write() before. It is not necessary to call + * endTransmission() after read(). * * @param len number of bytes to read * @return bytes read from device @@ -253,8 +253,8 @@ public class I2C { /** * Add bytes to be written to the device
*
- * You must call beginTransmission() before calling this function. The actual - * writing takes part when read() or endTransmission() is being called. + * You must call beginTransmission() before calling this function. The actual + * writing takes part when read() or endTransmission() is being called. * * @param out bytes to be written * @see beginTransmission diff --git a/java/libraries/io/src/processing/io/SoftwareServo.java b/java/libraries/io/src/processing/io/SoftwareServo.java index df01fd8bf..321959664 100644 --- a/java/libraries/io/src/processing/io/SoftwareServo.java +++ b/java/libraries/io/src/processing/io/SoftwareServo.java @@ -83,10 +83,10 @@ public class SoftwareServo { /** * Attaches a servo motor to a GPIO pin
*
- * You must call this function before calling write(). Note that the servo motor - * will only be instructed to move after the first time write() is called.
+ * You must call this function before calling write(). Note that the servo motor + * will only be instructed to move after the first time write() is called.
*
- * The optional parameters minPulse and maxPulse control the minimum and maximum + * The optional parameters minPulse and maxPulse control the minimum and maximum * pulse width durations. The default values, identical to those of Arduino's * Servo class, should be compatible with most servo motors. * @@ -105,8 +105,8 @@ public class SoftwareServo { /** * Attaches a servo motor to a GPIO pin
*
- * You must call this function before calling write(). Note that the servo motor - * will only be instructed to move after the first time write() is called.
+ * You must call this function before calling write(). Note that the servo motor + * will only be instructed to move after the first time write() is called.
*
* The optional parameters minPulse and maxPulse control the minimum and maximum * pulse width durations. The default values, identical to those of Arduino's diff --git a/java/libraries/serial/src/processing/serial/Serial.java b/java/libraries/serial/src/processing/serial/Serial.java index d843963b7..af044c160 100644 --- a/java/libraries/serial/src/processing/serial/Serial.java +++ b/java/libraries/serial/src/processing/serial/Serial.java @@ -198,10 +198,10 @@ public class Serial implements SerialPortEventListener { /** - * Sets the number of bytes to buffer before calling serialEvent() + * Sets the number of bytes to buffer before calling serialEvent() * @generate Serial_buffer.xml * @webref serial - * @webBrief Sets the number of bytes to buffer before calling serialEvent() + * @webBrief Sets the number of bytes to buffer before calling serialEvent() * @usage web_application * @param size number of bytes to buffer */ @@ -722,7 +722,7 @@ public class Serial implements SerialPortEventListener { /** - * Writes bytes, chars, ints, bytes[], Strings to the serial port + * Writes bytes, chars, ints, bytes[], Strings to the serial port * *

Advanced

* Write a String to the output. Note that this doesn't account @@ -737,7 +737,7 @@ public class Serial implements SerialPortEventListener { * (i.e. UTF8 or two-byte Unicode data), and send it as a byte array. * * @webref serial - * @webBrief Writes bytes, chars, ints, bytes[], Strings to the serial port + * @webBrief Writes bytes, chars, ints, bytes[], Strings to the serial port * @usage web_application * @param src data to write */