Fixes #96 by clarifying descriptions of boolean() byte() char() float() int() and str()

Scott Murray · Scott Murray · commit da53c26c8aac · 2014-08-17T15:53:10.000-07:00
diff --git a/content/api_en/binary.xml b/content/api_en/binary.xml
@@ -22,7 +22,7 @@ println(binary(c, 16)); // Prints "1100110000000000"
 
 
 <description><![CDATA[
-Converts a byte, char, int, or color to a String containing the equivalent binary notation. For example, the color value produced by <b>color(0, 102, 153, 255)</b> will convert to the String value "11111111000000000110011010011001". This function can help make your geeky debugging sessions much happier.<br/>
+Converts an <b>int</b>, <b>byte</b>, <b>char</b>, or <b>color</b> to a <b>String</b> containing the equivalent binary notation. For example, the <b>color</b> value produced by <b>color(0, 102, 153, 255)</b> will convert to the <b>String</b> value <b>"11111111000000000110011010011001"</b>. This function can help make your geeky debugging sessions much happier.<br/>
 <br/>
 Note that the maximum number of digits is 32, because an <b>int</b> value can only represent up to 32 bits. Specifying more than 32 digits will have no effect.
 ]]></description>
diff --git a/content/api_en/include/booleanconvert.xml b/content/api_en/include/booleanconvert.xml
@@ -20,7 +20,9 @@ if (b) {
 </example>
 
 <description><![CDATA[
-Converts an int, string, or array to its boolean representation. For int calues, the number 0 evaluates to false and all other numbers evaluate to true. 
+Converts an <b>int</b> or <b>String</b> to its boolean representation.  For an <b>int</b>, any non-zero value (positive or negative) evaluates to true, while zero evaluates to false. For a <b>String</b>, the value <b>"true"</b> evaluates to true, while any other value (including <b>"false"</b> or <b>"hippopotamus"</b>) evaluates to false.<br />
+<br />
+When an array of <b>int</b> or <b>String</b> values is passed in, then a <b>boolean</b> array of the same length is returned.
 ]]></description>
 
 </root>
diff --git a/content/api_en/include/byteconvert.xml b/content/api_en/include/byteconvert.xml
@@ -20,7 +20,9 @@ println(i + " : " + b);  // Prints "130 : -126"
 </example>
 
 <description><![CDATA[
-Converts a primitive datatype or array to its byte representation. A byte can only be a whole number between -128 and 127, therefore when a number outside this range is converted, its value wraps to the corresponding byte representation.
+Converts any value of a primitive data type (<b>boolean</b>, <b>byte</b>, <b>char</b>, <b>color</b>, <b>double</b>, <b>float</b>, <b>int</b>, or <b>long</b>) to its byte representation. A byte can only be a whole number between <b>-128</b> and <b>127</b>, so when a value outside of this range is converted, it wraps around to the corresponding byte representation.  (For example, <b>byte(128)</b> evaluates to <b>-128</b>.)<br />
+<br />
+When an array of values is passed in, then a <b>byte</b> array of the same length is returned.
 ]]></description>
 
 </root>
diff --git a/content/api_en/include/charconvert.xml b/content/api_en/include/charconvert.xml
@@ -20,7 +20,9 @@ println(b + " : " + c);  // Prints "65 : A"
 </example>
 
 <description><![CDATA[
-Converts a primitive datatype or array to a numeric character representation.
+Converts any value of a primitive data type (<b>boolean</b>, <b>byte</b>, <b>char</b>, <b>color</b>, <b>double</b>, <b>float</b>, <b>int</b>, or <b>long</b>) to its numeric character representation.<br />
+<br />
+When an array of values is passed in, then a <b>char</b> array of the same length is returned.
 ]]></description>
 
 </root>
diff --git a/content/api_en/include/floatconvert.xml b/content/api_en/include/floatconvert.xml
@@ -16,7 +16,9 @@ println(i + " : " + f);  // Prints "65 : 65.0"
 </example>
 
 <description><![CDATA[
-Converts an int, string, or array to its floating point representation.
+Converts an <b>int</b> or <b>String</b> to its floating point representation.  An <b>int</b> is easily converted to a <b>float</b>, but the contents of a <b>String</b> must resemble a number, or <b>NaN</b> (not a number) will be returned.  For example, <b>float("1234.56")</b> evaluates to <b>1234.56</b>, but <b>float("giraffe")</b> will return <b>NaN</b>.<br />
+<br />
+When an array of <b>int</b> or <b>String</b> values is passed in, then a floating point array of the same length is returned.
 ]]></description>
 
 </root>
diff --git a/content/api_en/include/intconvert.xml b/content/api_en/include/intconvert.xml
@@ -20,7 +20,9 @@ println(c + " : " + i);  // Prints "E : 69"
 </example>
 
 <description><![CDATA[
-Converts a primitive datatype, string, or array to its integer representation.
+Converts any value of a primitive data type (<b>boolean</b>, <b>byte</b>, <b>char</b>, <b>color</b>, <b>double</b>, <b>float</b>, <b>int</b>, or <b>long</b>) to its integer representation.<br />
+<br />
+When an array of values is passed in, then an <b>int</b> array of the same length is returned.
 ]]></description>
 
 </root>
diff --git a/content/api_en/include/strconvert.xml b/content/api_en/include/strconvert.xml
@@ -29,7 +29,9 @@ println(sb);  // Prints 'false-28R-32.61024'
 </example>
 
 <description><![CDATA[
-Returns the string representation of primitive datatypes and arrays. For example the integer 3 will return the string "3", the float -12.6 will return the string "-12.6", and a boolean value true will return the string "true".
+Converts any value of a primitive data type (<b>boolean</b>, <b>byte</b>, <b>char</b>, <b>color</b>, <b>double</b>, <b>float</b>, <b>int</b>, or <b>long</b>) to its <b>String</b> representation. For example, converting an integer with <b>str(3)</b> will return the <b>String</b> value of <b>"3"</b>, converting a float with <b>str(-12.6)</b> will return <b>"-12.6"</b>, and converting a boolean with <b>str(true)</b> will return <b>"true"</b>.<br />
+<br />
+When an array of values is passed in, then a <b>String</b> array of the same length is returned.
 ]]></description>
 
 </root>
