eessppeelllloo/processing4
1
0
Fork 0
mirror of https://github.com/processing/processing4.git synced 2026-06-16 04:26:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Formatting more comments

Browse Source
This commit is contained in:
Anadroid
2021-04-12 10:24:07 +02:00
parent 69700fbeeb
commit 7b5c8ba9ce
18 changed files with 132 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/src/processing/core/PApplet.java
+21 -21
View File
@@ -5530,9 +5530,9 @@ public class PApplet implements PConstants {
* <br />
* If the file is not available or an error occurs, <b>null</b> 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 <b>null</b> value may cause a
* NullPointerException if your code does not check whether the value returned
* is null.<br />
* is <b>null</b>.<br />
* <br />
* The <b>extension</b> 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 <b>null</b> value is
* returned.<br />
* <br />
* <b>parseXML()</b> 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
* <b>parseXML()</b>. Be sure to check if null is returned before performing
* <b>parseXML()</b>. Be sure to check if <b>null</b> is returned before performing
* operations on the new XML object, in case the String content could not be
* parsed.<br />
* <br />
@@ -6185,9 +6185,9 @@ public class PApplet implements PConstants {
* <br />
* If the file is not available or an error occurs, <b>null</b> 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 <b>null</b> value may cause a
* NullPointerException if your code does not check whether the value returned
* is null.<br />
* is <b>null</b>.<br />
* <br />
* Use <b>createFont()</b> (instead of <b>loadFont()</b>) 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, <b>null</b> 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, <b>null</b> 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)<br />
* <br />
* If the requested item doesn't exist, null is returned. If not online,
* If the requested item doesn't exist, <b>null</b> 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 {
* <br />
* If the file is not available or an error occurs, <b>null</b> 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 <b>null</b> value may cause a
* NullPointerException if your code does not check whether the value returned
* is null.<br />
* is <b>null</b>.<br />
*
* @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 {
* <br />
* If the file is not available or an error occurs, <b>null</b> 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 <b>null</b> value may cause a
* NullPointerException if your code does not check whether the value returned
* is null.<br />
* is <b>null</b>.<br />
* <br />
* 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 <b>null</b> 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.<br />
* <br />
* 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 <b>null</b>. If the
* result is null, then the sequence did not match at all. If the sequence did
* match, an array is returned.<br />
* <br />
@@ -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 <b>String</b> array. No match will return <b>null</b>.
* @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 <b>null</b> 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.<br />
* <br />
* 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 <b>null</b>. If the
* result is null, then the sequence did not match at all. If the sequence did
* match, a 2D array is returned.<br />
* <br />
@@ -11524,9 +11524,9 @@ public class PApplet implements PConstants {
* <br />
* If the file is not available or an error occurs, <b>null</b> 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 <b>null</b> value
* may cause a NullPointerException if your code does not check whether
* the value returned is null.<br />
* the value returned is <b>null</b>.<br />
*
* @webref shape
* @webBrief Loads geometry into a variable of type <b>PShape</b>.
@@ -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.<br />
* whether the value returned is <b>null</b>.<br />
*
*
* @webref rendering:shaders
core/src/processing/data/FloatDict.java
+3 -3
View File
@@ -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 <b>String</b> 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 <b>String</b> 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
core/src/processing/data/FloatList.java
+3 -3
View File
@@ -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 <b>ArrayLists</b>, 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 <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get
* a sorted copy, use <b>list.copy().sort()</b>.
*
* @webref data:composite
* @webBrief Helper class for a list of floats.
core/src/processing/data/IntDict.java
+2 -2
View File
@@ -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 <b>String</b> 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 <b>String</b> as a lookup for an int value.
* @see FloatDict
* @see StringDict
*/
core/src/processing/data/IntList.java
+3 -3
View File
@@ -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 <b>ArrayLists</b>, 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 <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get
* a sorted copy, use <b>list.copy().sort()</b>.
*
* @webref data:composite
* @webBrief Helper class for a list of ints.
core/src/processing/data/JSONArray.java
+9 -9
View File
@@ -279,7 +279,7 @@ public class JSONArray {
/**
* Gets the String value associated with the specified index.
* Gets the <b>String</b> 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 <b>JSONArray</b> as an array of Strings.
* (All values in the array must be of the String type.)
* Returns the entire <b>JSONArray</b> as an array of <b>Strings</b>.
* (All values in the array must be of the <b>String</b> type.)
*
* @webref jsonarray:method
* @webBrief Returns the entire <b>JSONArray</b> as an array of Strings
* @webBrief Returns the entire <b>JSONArray</b> as an array of <b>Strings</b>
* @see JSONArray#getIntArray()
*/
public String[] getStringArray() {
@@ -579,11 +579,11 @@ public class JSONArray {
/**
* Returns the entire <b>JSONArray</b> as an array of ints.
* Returns the entire <b>JSONArray</b> as an array of <b>ints</b>.
* (All values in the array must be of the int type.)
*
* @webref jsonarray:method
* @webBrief Returns the entire <b>JSONArray</b> as an array of ints
* @webBrief Returns the entire <b>JSONArray</b> as an array of <b>ints</b>
* @see JSONArray#getStringArray()
*/
public int[] getIntArray() {
@@ -702,8 +702,8 @@ public class JSONArray {
/**
* Appends a new value to the <b>JSONArray</b>, increasing the array's length
* by one. New values may be of the following types: int, float, String,
* boolean, <b>JSONObject</b>, or <b>JSONArray</b>.
* by one. New values may be of the following types: <b>int</b>, <b>float</b>, <b>String</b>,
* <b>boolean</b>, <b>JSONObject</b>, or <b>JSONArray</b>.
*
* @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 <b>JSONArray</b> 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 <b>null</b>, if there
* is no value.
*
* @webref jsonarray:method
core/src/processing/data/JSONObject.java
+2 -2
View File
@@ -52,7 +52,7 @@ import processing.core.PApplet;
/**
* A <b>JSONObject</b> stores JSON data with multiple name/value pairs. Values
* can be numeric, Strings, booleans, other <b>JSONObject</b>s or
* can be numeric, <b>Strings</b>, <b>booleans</b>, other <b>JSONObject</b>s or
* <b>JSONArray</b>s, or null. <b>JSONObject</b> and <b>JSONArray</b> 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 <b>String</b> value associated with the specified key.
*
* @webref jsonobject:method
* @webBrief Gets the String value associated with the specified key
core/src/processing/data/LongList.java
+1 -1
View File
@@ -710,7 +710,7 @@ public class LongList implements Iterable<Long> {
/**
* Randomize the order of the list elements. Note that this does not
* obey the randomSeed() function in PApplet.
* obey the <b>randomSeed()</b> function in PApplet.
*
* @webref intlist:method
* @webBrief Randomize the order of the list elements
core/src/processing/data/StringDict.java
+2 -2
View File
@@ -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 <b>String</b> as a lookup for a <b>String</b> value. String "keys"
* are associated with <b>String</b> values.
*
* @webref data:composite
* @webBrief A simple class to use a String as a lookup for an String value
core/src/processing/data/StringList.java
+5 -5
View File
@@ -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 <b>Strings</b>. Lists are designed to have some of the
* features of <b>ArrayLists</b>, 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 <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get
* a sorted copy, use <b>list.copy().sort()</b>.
*
* @webref data:composite
* @webBrief Helper class for a list of Strings.
@@ -149,7 +149,7 @@ public class StringList implements Iterable<String> {
/**
* 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 <b>null</b>.
*
* @webref stringlist:method
* @webBrief Set an entry at a particular index
core/src/processing/data/Table.java
+5 -5
View File
@@ -1806,9 +1806,9 @@ public class Table {
* Use <b>addColumn()</b> to add a new column to a <b>Table</b> 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 <b>null</b>.) A column type may also be specified, in which case all values
* stored in this column must be of the same type (e.g., <b>Table.INT</b> or
* <b>Table.FLOAT</b>). If no type is specified, the default type of <b>STRING</b> is used.
*
* @webref table:method
* @webBrief Adds a new column to a table
@@ -1886,7 +1886,7 @@ public class Table {
/**
* Use <b>removeColumn()</b> to remove an existing column from a <b>Table</b>
* object. The column to be removed may be identified by either its title (a
* String) or its index value (an int). <b>removeColumn(0)</b> would remove the
* <b>String</b>) or its index value (an <b>int</b>). <b>removeColumn(0)</b> would remove the
* first column, <b>removeColumn(1)</b> 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 <b>String</b>
* array. The column may be specified by either its ID or title.
*
* @webref table:method
core/src/processing/data/TableRow.java
+3 -3
View File
@@ -99,7 +99,7 @@ public interface TableRow {
public double getDouble(String columnName);
/**
* Stores a String value in the <b>TableRow</b>'s specified column. The column
* Stores a <b>String</b> value in the <b>TableRow</b>'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 <b>TableRow</b>'s specified column. The column
* Stores an <b>integer</b> value in the <b>TableRow</b>'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 <b>TableRow</b>'s specified column. The column
* Stores a <b>float</b> value in the <b>TableRow</b>'s specified column. The column
* may be specified by either its ID or title.
*
* @webref tablerow:method
core/src/processing/data/XML.java
+44 -44
View File
@@ -41,16 +41,16 @@ import processing.core.PApplet;
/**
* <b>XML</b> is a representation of an XML object, able to parse XML code. Use
* <b>XML</b> is a representation of an <b>XML</b> object, able to parse <b>XML</b> code. Use
* <b>loadXML()</b> to load external XML files and create <b>XML</b>
* objects.<br />
* <br />
* Only files encoded as UTF-8 (or plain ASCII) are parsed properly; the
* encoding parameter inside XML files is ignored.
* encoding parameter inside <b>XML</b> 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 <b>XML</b> 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 <b>String</b> content to an <b>XML</b> object
*
* @webref xml:method
* @webBrief Converts String content to an XML object
* @webBrief Converts <b>String</b> content to an <b>XML</b> 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 <b>XML</b> 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 <b>String</b>.
*
* @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 <b>String</b>.
*
* @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 <b>boolean</b>.
*
* @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 <b>Strings</b>. This is the same as looping through and calling <b>getName()</b>
* 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 <b>XML</b> objects. When
* the <b>name</b> 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.<br />
* <b>String</b>, which will be used as the new tag's name, or as a reference to an
* existing <b>XML</b> object.<br />
* <br />
* A reference to the newly created child is returned as an XML object.
* A reference to the newly created child is returned as an <b>XML</b> 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 <b>int</b>.
*
* @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 <b>Strings</b>.
*
* @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 <b>String</b>, and a <b>boolean</b> 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 <b>defaultValue</b>
* Returns an attribute value of the element as a <b>String</b>. If the <b>defaultValue</b>
* parameter is specified and the attribute doesn't exist, then <b>defaultValue</b>
* is returned. If no <b>defaultValue</b> is specified and the attribute doesn't
* exist, null is returned.
* exist, <b>null</b> is returned.
*
* @webref xml:method
* @webBrief Gets the content of an attribute as a String
* @webBrief Gets the content of an attribute as a <b>String</b>
*/
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 <b>String</b>. The first <b>String</b>
* 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 <b>String</b>
*/
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 <b>defaultValue</b>
* Returns an attribute value of the element as an <b>int</b>. If the <b>defaultValue</b>
* parameter is specified and the attribute doesn't exist, then <b>defaultValue</b>
* is returned. If no <b>defaultValue</b> 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 <b>int</b>
*/
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 <b>int</b>. A <b>String</b> 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 <b>int</b>
*/
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 <b>int</b>
*
* @webref xml:method
* @webBrief Sets the content of an element as an int
* @webBrief Sets the content of an element as an <b>int</b>
*/
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 <b>float</b>
*/
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 <b>float</b>. A <b>String</b> specifies
* the attribute name, while the <b>float</b> 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 <b>float</b>
*/
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 <b>int</b>. If there is no such content,
* either <b>null</b> 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 <b>int</b>
* @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 <b>float</b>. If there is no such content,
* either <b>null</b> 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 <b>float</b>
* @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 <b>String</b>.
*
* @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 <b>XML</b> object and converts it to a <b>String</b>, formatting its content as
* specified with the <b>indent</b> parameter.<br />
* <br />
* If indent is set to -1, then the String is returned with no line breaks, no
* indentation, and no XML declaration.<br />
* indentation, and no <b>XML</b> declaration.<br />
* <br />
* 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 <b>String</b> 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 <b>XML</b> data as a <b>String</b>
* @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 <b>XML</b> object and converts it to a <b>String</b>, using default formatting
* rules (includes an XML declaration, line breaks, and two spaces for indents).
* These are the same formatting rules used by <b>println()</b> when printing an
* XML object. This method produces the same results as using <b>format(2)</b>.
* <b>XML</b> object. This method produces the same results as using <b>format(2)</b>.
*
* @webref xml:method
* @webBrief Gets XML data as a String using default formatting
* @webBrief Gets <b>XML</b> data as a <b>String</b> using default formatting
* @return the content
* @see XML#format(int)
*/
core/src/processing/opengl/PShader.java
+1 -1
View File
@@ -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 <b>loadShader()</b> function to load your
* shader code. [Note: It's strongly encouraged to use <b>loadShader()</b> to
* create a PShader object, rather than calling the PShader constructor
* create a <b>PShader</b> object, rather than calling the <b>PShader</b> constructor
* manually.]
*
* @webref rendering:shaders
java/libraries/io/src/processing/io/GPIO.java
+13 -13
View File
@@ -94,16 +94,16 @@ public class GPIO {
/**
* Calls a function when the value of an input pin changes<br/>
* <br/>
* The sketch method provided must accept a single integer (int) parameter, which is the
* The sketch method provided must accept a single <b>integer</b> (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 <b>draw()</b> call, as
* shown above. Calling functions of the Hardware I/O library at this point is certainly
* possible.<br/>
* <br/>
* 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: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from low
* to high, and <b>GPIO.CHANGE</b> when either occurs.
*
* @param pin GPIO pin
* @param parent typically use "this"
@@ -333,7 +333,7 @@ public class GPIO {
* Allows interrupts to happen<br/>
* <br/>
* You can use <a href="GPIO_noInterrupts_.html">noInterrupts()</a>
* and interrupts() in tandem to make sure no interrupts are occuring
* and <b>interrupts()</b> 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<br/>
* <br/>
* You can use noInterrupts() and <a href="GPIO_interrupts_.html">interrupts()</a>
* You can use <b>noInterrupts()</b> and <a href="GPIO_interrupts_.html">interrupts()</a>
* in tandem to make sure no interrupts are occuring while your sketch is doing a
* particular task.<br/>
* br/>
@@ -529,9 +529,9 @@ public class GPIO {
/**
* Waits for the value of an input pin to change<br/>
* <br/>
* 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.<br/>
* The mode parameter determines when the function will return: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from
* low to high, and <b>GPIO.CHANGE</b> when either occurs.<br/>
* <br/>
* 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<br/>
* <br/>
* 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.<br/>
* The mode parameter determines when the function will return: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from
* low to high, and <b>GPIO.CHANGE</b> when either occurs.<br/>
* <br/>
* 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
java/libraries/io/src/processing/io/I2C.java
+6 -6
View File
@@ -150,7 +150,7 @@ public class I2C {
* <br/>
* This executes any queued writes. <a href="I2C_read_.html">Read()</a>
* implicitly ends the current transmission as well, hence calling
* endTransmission() afterwards is not necessary.
* <b>endTransmission()</b> afterwards is not necessary.
*
* @see beginTransmission
* @see write
@@ -212,10 +212,10 @@ public class I2C {
/**
* Read bytes from the attached device<br/>
* <br/>
* You must call beginTransmission() before calling this function. This function
* You must call <b>beginTransmission()</b> 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
* <a href="I2C_endTransmission_.html">endTransmission()</a> after read().
* <b>write()</b> before. It is not necessary to call
* <a href="I2C_endTransmission_.html">endTransmission()</a> after <b>read()</b>.
*
* @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<br/>
* <br/>
* You must call beginTransmission() before calling this function. The actual
* writing takes part when read() or endTransmission() is being called.
* You must call <b>beginTransmission()</b> before calling this function. The actual
* writing takes part when <b>read()</b> or <b>endTransmission()</b> is being called.
*
* @param out bytes to be written
* @see beginTransmission
java/libraries/io/src/processing/io/SoftwareServo.java
+5 -5
View File
@@ -83,10 +83,10 @@ public class SoftwareServo {
/**
* Attaches a servo motor to a GPIO pin<br/>
* <br/>
* 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.<br/>
* You must call this function before calling <b>write()</b>. Note that the servo motor
* will only be instructed to move after the first time <b>write()</b> is called.<br/>
* <br/>
* The optional parameters minPulse and maxPulse control the minimum and maximum
* The optional parameters <b>minPulse</b> and <b>maxPulse</b> 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<br/>
* <br/>
* 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.<br/>
* You must call this function before calling <b>write()</b>. Note that the servo motor
* will only be instructed to move after the first time <b>write()</b> is called.<br/>
* <br/>
* The optional parameters minPulse and maxPulse control the minimum and maximum
* pulse width durations. The default values, identical to those of Arduino's
java/libraries/serial/src/processing/serial/Serial.java
+4 -4
View File
@@ -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 <b>serialEvent()</b>
* @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 <b>serialEvent()</b>
* @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 <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b> to the serial port
*
* <h3>Advanced</h3>
* 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 <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b> to the serial port
* @usage web_application
* @param src data to write
*/