Formatting more comments

Author: Anadroid

core/src/processing/core/PApplet.java

@@ -5530,9 +5530,9 @@ public void noiseSeed(long seed) {
    * <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 XML loadXML(String filename, String options) {
 
   /**
    * 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 boolean saveTable(Table table, String filename, String options) {
    * <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 @@ private Frame selectFrame() {
   /**
    * 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 @@ static public void selectInput(String prompt, String callbackMethod,
   /**
    * 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 @@ static public PrintWriter createWriter(OutputStream output) {
    * - 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 @@ static public InputStream createInput(File file) {
    * <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 @@ static public String[] loadStrings(File file) {
    * <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 @@ protected boolean removeEldestEntry(Map.Entry<String, Pattern> eldest) {
    *
    * 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 @@ protected boolean removeEldestEntry(Map.Entry<String, Pattern> eldest) {
    * @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 @@ static public String[] match(String str, String regexp) {
    *
    * 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 void endShape(int mode) {
    * <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 PShape createShape(int kind, float... p) {
    * 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

@@ -9,11 +9,11 @@
 
 
 /**
- * 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 boolean hasKey(String key) {
 
 
   /**
-   * 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

@@ -11,11 +11,11 @@
 
 /**
  * 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

@@ -9,11 +9,11 @@
 
 
 /**
- * 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

@@ -16,11 +16,11 @@
 
 /**
  * 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

@@ -279,7 +279,7 @@ public Object get(int index) {
 
 
   /**
-   * 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 JSONObject getJSONObject(int index, JSONObject defaultValue) {
 
 
   /**
-   * 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 String[] getStringArray() {
 
 
   /**
-   * 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 boolean[] getBooleanArray() {
 
   /**
    * 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 boolean isNull(int index) {
 
   /**
    * 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

@@ -52,7 +52,7 @@ of this software and associated documentation files (the "Software"), to deal
 
 /**
  * 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 Object get(String key) {
 
 
   /**
-   * 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

@@ -710,7 +710,7 @@ public void reverse() {
 
   /**
    * 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

@@ -9,8 +9,8 @@
 
 
 /**
- * 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

@@ -9,12 +9,12 @@
 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 String get(int index) {
   /**
    * 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