Skip to content

Commit 2f4e1f7

Browse files
scotthmurrayscotthmurray
committed
Parameter alignment
1 parent 7b0a131 commit 2f4e1f7

File tree

13 files changed

+25
-30
lines changed

13 files changed

+25
-30
lines changed

‎content/api_en/hex.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ println(hex(c, 6)); // Prints "FFCC00"
3232
<description><![CDATA[
3333
Converts a byte, char, int, or color to a String containing the equivalent hexadecimal notation. For example color(0, 102, 153) will convert to the String "FF006699". This function can help make your geeky debugging sessions much happier.
3434
<br/> <br/>
35-
Note that the maximum number of digits is 8, because an int value can only represent up to 32 bits. Specifying more than eight digits will simply shorten the string to eight anyway.
35+
Note that the maximum number of digits is 8, because an int value can only represent up to 32 bits. Specifying more than eight digits will not increase the length of the string further.
3636
]]></description>
3737

3838
</root>

‎content/api_en/include/Array.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Another common source of confusion is the difference between using <b>length</b>
5959

6060
<parameter>
6161
<label>datatype</label>
62-
<description><![CDATA[any primitive or compound datatype, including user defined classes]]></description>
62+
<description><![CDATA[any primitive or compound datatype, including user-defined classes]]></description>
6363
</parameter>
6464

6565
<parameter>

‎content/api_en/include/ArrayList.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ ArrayList(<c>initialCapacity</c>)
6868

6969
<cparameter>
7070
<clabel>initialCapacity</clabel>
71-
<cdescription>int: defines the initial capacity of the list, it's empty by default</cdescription>
71+
<cdescription>int: defines the initial capacity of the list; it's empty by default</cdescription>
7272
</cparameter>
7373

7474
<returns></returns>

‎content/api_en/include/HashMap.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ HashMap(<c>m</c>)
4646

4747
<parameter>
4848
<label>initialCapacity</label>
49-
<description>int: defines the initial capacity of the map, it's 16 by default</description>
49+
<description>int: defines the initial capacity of the map; the default is 16</description>
5050
</parameter>
5151

5252
<parameter>
5353
<label>loadFactor</label>
54-
<description>float: the load factor for the map, the default is 0.75</description>
54+
<description>float: the load factor for the map; the default is 0.75</description>
5555
</parameter>
5656

5757
<parameter>

‎content/api_en/include/String.xml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ if (p.equals("potato")) {
3838
<image></image>
3939
<code><![CDATA[
4040
// Use a backslash to include quotes in a String
41-
String quoted = "This one has \\"quotes\\"";
41+
String quoted = "This one has &#92;"quotes&#92;"";
4242
println(quoted); // This one has "quotes"
4343
]]></code>
4444
</example>
4545

4646
<description><![CDATA[
47-
A string is a sequence of characters. The class <b>String</b> includes methods for examining individual characters, comparing strings, searching strings, extracting parts of strings, and for converting an entire string uppercase and lowercase. Strings are always defined inside double quotes ("Abc") and characters are always defined inside single quotes('A').
48-
<br /> <br />
47+
A string is a sequence of characters. The class <b>String</b> includes methods for examining individual characters, comparing strings, searching strings, extracting parts of strings, and for converting an entire string uppercase and lowercase. Strings are always defined inside double quotes ("Abc"), and characters are always defined inside single quotes ('A').<br/>
48+
<br/>
4949
To compare the contents of two Strings, use the <b>equals()</b> method, as in "if (a.equals(b))", instead of "if (a == b)". A String is an Object, so comparing them with the == operator only compares whether both Strings are stored in the same memory location. Using the <b>equals()</b> method will ensure that the actual contents are compared. (The <a href="http://wiki.processing.org/w/Troubleshooting#Why_don.27t_these_Strings_equal.3F">troubleshooting</a> reference has a longer explanation.)<br />
5050
<br />
51-
Because a String is defined within quotes, including quotes in a String requires the \\ (backslash) character to be used (see the second example above). This is known as an <em>escape sequence</em>. Other escape sequences include \\t for the tab character, and \\n for new line. A single backslash is indicated by \\.<br />
52-
<br />
51+
Because a String is defined between quotation marks, to include such marks within the String itself you must use the &#92; (backslash) character. (See the third example above.) This is known as an <em>escape sequence</em>. Other escape sequences include &#92;t for the tab character and &#92;n for new line. Because backslash is the escape character, to include a single backslash within a String, you must use two consecutive backslashes, as in: &#92;&#92;<br/>
52+
<br/>
5353
There are more string methods than those linked from this page. Additional documentation is located online in the <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html">official Java documentation.</a>.
5454
]]></description>
5555

@@ -97,7 +97,7 @@ String(<c>data</c>, <c>offset</c>, <c>length</c>)
9797

9898
<cparameter>
9999
<clabel>data</clabel>
100-
<cdescription>byte[] or char[]: array of bytes to be decoded into characters or array of characters to be combined into a string</cdescription>
100+
<cdescription>byte[] or char[]: either an array of bytes to be decoded into characters, or an array of characters to be combined into a string</cdescription>
101101
</cparameter>
102102

103103
<cparameter>

‎content/api_en/include/arrayaccess.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The array access operator is used to specify a location within an array. The dat
3131

3232
<parameter>
3333
<label>datatype</label>
34-
<description><![CDATA[any primitive or compound datatype, including user defined classes]]></description>
34+
<description><![CDATA[any primitive or compound datatype, including user-defined classes]]></description>
3535
</parameter>
3636

3737
<parameter>
@@ -41,7 +41,7 @@ The array access operator is used to specify a location within an array. The dat
4141

4242
<parameter>
4343
<label>element</label>
44-
<description><![CDATA[int: must not exceed the length of the array - 1]]></description>
44+
<description><![CDATA[int: must not exceed the length of the array minus 1]]></description>
4545
</parameter>
4646

4747
<returns></returns>

‎content/api_en/include/catch.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ try {
5353

5454
<parameter>
5555
<label>tryStatements</label>
56-
<description><![CDATA[if this code throws an exception, then the code in catch is run]]></description>
56+
<description><![CDATA[if this code throws an exception, then the code in "catch" is run]]></description>
5757
</parameter>
5858

5959
<parameter>
6060
<label>exception</label>
61-
<description><![CDATA[a Java exception]]></description>
61+
<description><![CDATA[the Java exception that was thrown]]></description>
6262
</parameter>
6363

6464
<parameter>

‎content/api_en/include/curlybraces.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Define the beginning and end of functions blocks and statement blocks such as th
4040
</parameter>
4141

4242
<parameter>
43-
<label>ele0 ... eleN</label>
43+
<label>ele0, ..., eleN</label>
4444
<description><![CDATA[list of elements separated by commas]]></description>
4545
</parameter>
4646

‎content/api_en/include/dot.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ Provides access to an object's methods and data. An object is one instance of a
5555

5656
<parameter>
5757
<label>object</label>
58-
<description><![CDATA[the object you want to access]]></description>
58+
<description><![CDATA[the object to be accessed]]></description>
5959
</parameter>
6060

6161
<parameter>
6262
<label>method()</label>
63-
<description><![CDATA[method encapsulated in the object]]></description>
63+
<description><![CDATA[a method encapsulated in the object]]></description>
6464
</parameter>
6565

6666
<parameter>
6767
<label>data</label>
68-
<description><![CDATA[variable or constant encapsulated in the object]]></description>
68+
<description><![CDATA[a variable or constant encapsulated in the object]]></description>
6969
</parameter>
7070

7171
<returns></returns>

‎content/api_en/include/extends.xml‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,6 @@ Note that in Java, and therefore also Processing, you cannot extend a class more
4646

4747
<syntax></syntax>
4848

49-
<parameter>
50-
<label></label>
51-
<description></description>
52-
</parameter>
53-
5449
<returns></returns>
5550

5651
<related>

0 commit comments

Comments
 (0)