Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion content/references/translations/en/io/SPI_settings_.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
{
"name": "mode",
"description": "<a href=\n \"https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase\">SPI.MODE0\n to SPI.MODE3</a>",
"description": "<a href=\"https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase\">,SPI.MODE0\n to SPI.MODE3,</a>",
"type": ["int"]
}
]
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Client.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
"description": "A client connects to a server and sends data back and forth. If anything \n goes wrong with the connection, for example the host is not there or is \n listening on a different port, an exception is thrown.",
"description": "A client connects to a server and sends data back and forth. If anything\n goes wrong with the connection, for example the host is not there or is\n listening on a different port, an exception is thrown.",
"type": "class",
"constructors": ["Client(parent, host, port)", "Client(parent, socket)"],
"related": ["LIB_net/clientEvent_"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Returns the number of bytes in the buffer waiting to be read",
"related": [],
"name": "available()",
"description": "Returns the number of bytes available. When any client has bytes \n available from the server, it returns the number of bytes.",
"description": "Returns the number of bytes available. When any client has bytes\n available from the server, it returns the number of bytes.",
"syntax": ["client.available()"],
"returns": "int",
"type": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Reads from the buffer of bytes up to and including a particular character",
"related": [],
"name": "readBytesUntil()",
"description": "Reads from the port into a buffer of bytes up to and including a \n particular character. If the character isn't in the buffer, 'null' is \n returned. The version with no <b>byteBuffer</b> parameter returns a byte \n array of all data up to and including the <b>interesting</b> byte. This \n is not efficient, but is easy to use. The version with the \n <b>byteBuffer</b> parameter is more memory and time efficient. It grabs \n the data in the buffer and puts it into the byte array passed in and \n returns an int value for the number of bytes read. If the byte buffer is \n not large enough, -1 is returned and an error is printed to the message \n area. If nothing is in the buffer, 0 is returned.",
"description": "Reads from the port into a buffer of bytes up to and including a\n particular character. If the character isn't in the buffer, 'null' is\n returned. The version with no <b>byteBuffer</b> parameter returns a byte\n array of all data up to and including the <b>interesting</b> byte. This\n is not efficient, but is easy to use. The version with the\n <b>byteBuffer</b> parameter is more memory and time efficient. It grabs\n the data in the buffer and puts it into the byte array passed in and\n returns an int value for the number of bytes read. If the byte buffer is\n not large enough, -1 is returned and an error is printed to the message\n area. If nothing is in the buffer, 0 is returned.",
"syntax": [
"client.readBytesUntil(interesting)",
"client.readBytesUntil(interesting, byteBuffer)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Reads a group of bytes from the buffer",
"related": [],
"name": "readBytes()",
"description": "Reads a group of bytes from the buffer. The version with no parameters \n returns a byte array of all data in the buffer. This is not efficient, \n but is easy to use. The version with the <b>byteBuffer</b> parameter is \n more memory and time efficient. It grabs the data in the buffer and puts \n it into the byte array passed in and returns an int value for the number \n of bytes read. If more bytes are available than can fit into the \n <b>byteBuffer</b>, only those that fit are read.\n \n ",
"description": "Reads a group of bytes from the buffer. The version with no parameters\n returns a byte array of all data in the buffer. This is not efficient,\n but is easy to use. The version with the <b>byteBuffer</b> parameter is\n more memory and time efficient. It grabs the data in the buffer and puts\n it into the byte array passed in and returns an int value for the number\n of bytes read. If more bytes are available than can fit into the\n <b>byteBuffer</b>, only those that fit are read.\n\n ",
"syntax": [
"client.readBytes()",
"client.readBytes(max)",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Returns the next byte in the buffer as a char",
"related": [],
"name": "readChar()",
"description": "Returns the next byte in the buffer as a char. Returns <b>-1</b> or \n <b>0xffff</b> if nothing is there.",
"description": "Returns the next byte in the buffer as a char. Returns <b>-1</b> or\n <b>0xffff</b> if nothing is there.",
"syntax": ["client.readChar()"],
"returns": "char",
"type": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Returns the buffer as a <b>String</b> up to and including a particular character",
"related": [],
"name": "readStringUntil()",
"description": "Combination of <b>readBytesUntil()</b> and <b>readString()</b>. Returns \n <b>null</b> if it doesn't find what you're looking for.\n \n ",
"description": "Combination of <b>readBytesUntil()</b> and <b>readString()</b>. Returns\n <b>null</b> if it doesn't find what you're looking for.\n\n ",
"syntax": ["client.readStringUntil(interesting)"],
"returns": "String",
"type": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Returns the buffer as a <b>String</b>",
"related": [],
"name": "readString()",
"description": "Returns the all the data from the buffer as a <b>String</b>. This method \n assumes the incoming characters are ASCII. If you want to transfer \n Unicode data, first convert the String to a byte stream in the \n representation of your choice (i.e. UTF8 or two-byte Unicode data), and \n send it as a byte array.",
"description": "Returns the all the data from the buffer as a <b>String</b>.\n\n In 4.0 beta 3, changed to using UTF-8 as the encoding,\n otherwise the behavior is platform-dependent.",
"syntax": ["client.readString()"],
"returns": "String",
"type": "method",
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Client_read_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Returns a value from the buffer",
"related": [],
"name": "read()",
"description": "Returns a number between 0 and 255 for the next byte that's waiting in \n the buffer. Returns -1 if there is no byte, although this should be \n avoided by first cheacking <b>available()</b> to see if any data is available.",
"description": "Returns a number between 0 and 255 for the next byte that's waiting in\n the buffer. Returns -1 if there is no byte, although this should be\n avoided by first checking <b>available()</b> to see if any data is available.",
"syntax": ["client.read()"],
"returns": "int",
"type": "method",
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Client_stop_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Disconnects from the server",
"related": [],
"name": "stop()",
"description": "Disconnects from the server. Use to shut the connection when you're \n finished with the Client.",
"description": "Disconnects from the server. Use to shut the connection when you're\n finished with the Client.",
"syntax": ["client.stop()"],
"returns": "void",
"type": "method",
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Client_write_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Writes <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b>",
"related": [],
"name": "write()",
"description": "Writes data to a server specified when constructing the client, or writes \n data to the specific client obtained from the Server <b>available()</b> \n method.",
"description": "Writes data to a server specified when constructing the client, or writes\n data to the specific client obtained from the Server <b>available()</b>\n method.",
"syntax": ["client.write(data)"],
"returns": "void",
"type": "method",
Expand Down
4 changes: 2 additions & 2 deletions content/references/translations/en/net/Server.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"brief": "The server class is used to create server objects which send \n and receives data to and from its associated clients (other programs connected to it)",
"brief": "The server class is used to create server objects which send\n and receives data to and from its associated clients (other programs connected to it)",
"methods": [
{
"anchor": "Server_disconnect_",
Expand Down Expand Up @@ -30,7 +30,7 @@
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
"description": "A server sends and receives data to and from its associated clients \n (other programs connected to it). When a server is started, it begins \n listening for connections on the port specified by the <b>port</b> \n parameter. Computers have many ports for transferring data and some are \n commonly used so be sure to not select one of these. For example, web \n servers usually use port 80 and POP mail uses port 110.",
"description": "A server sends and receives data to and from its associated clients\n (other programs connected to it). When a server is started, it begins\n listening for connections on the port specified by the <b>port</b>\n parameter. Computers have many ports for transferring data and some are\n commonly used so be sure to not select one of these. For example, web\n servers usually use port 80 and POP mail uses port 110.",
"type": "class",
"constructors": ["Server(parent, port)", "Server(parent, port, host)"],
"related": [],
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Server_stop_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Disconnects all clients and stops the server",
"related": [],
"name": "stop()",
"description": "Disconnects all clients and stops the server.\n \n ",
"description": "Disconnects all clients and stops the server.\n\n ",
"syntax": ["server.stop()"],
"returns": "void",
"type": "method",
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/net/Server_write_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"brief": "Writes data to all connected clients",
"related": [],
"name": "write()",
"description": "Writes a value to all the connected clients. It sends bytes out from the \n Server object.",
"description": "Writes a value to all the connected clients. It sends bytes out from the\n Server object.",
"syntax": ["server.write(data)"],
"returns": "void",
"type": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "keys()",
"description": "Return the internal array being used to store the keys.",
"syntax": [".keys()"],
"returns": "Iterable",
"returns": "Iterable&lt;String&gt;",
"type": "method",
"category": "floatdict",
"subcategory": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "values()",
"description": "Return the internal array being used to store the values.",
"syntax": [".values()"],
"returns": "Iterable",
"returns": "Iterable&lt;Float&gt;",
"type": "method",
"category": "floatdict",
"subcategory": "method",
Expand Down
6 changes: 3 additions & 3 deletions content/references/translations/en/processing/FloatList.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@
"desc": "Randomize the order of the list elements"
},
{
"anchor": "FloatList_array_",
"name": "array()",
"anchor": "FloatList_toArray_",
"name": "toArray()",
"desc": "Create a new array with a copy of all the values"
}
],
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
"description": "Helper class for a list of floats. Lists are designed to have some of the\n features of <b>ArrayLists</b>, but to maintain the simplicity and efficiency of\n working with arrays.\n\n Functions like <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get\n a sorted copy, use <b>list.copy().sort()</b>.",
"description": "Helper class for a list of <b>float</b> values. Lists are designed\n to have some features of <b>ArrayList</b>, but to maintain the\n simplicity and efficiency of working with arrays.\n Functions such as <b>sort()</b> and <b>shuffle()</b> always act on\n the list itself. To get a sorted copy, use <b>list.copy().sort()</b>.",
"type": "class",
"constructors": ["FloatList()", "FloatList(items)"],
"related": ["IntList", "StringList"],
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"brief": "Create a new array with a copy of all the values",
"related": [],
"name": "toArray()",
"description": "Create a new array with a copy of all the values.",
"syntax": [".toArray()", ".toArray(array)"],
"returns": "float[]",
"type": "method",
"category": "floatlist",
"subcategory": "method",
"classanchor": "FloatList",
"parameters": []
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "keys()",
"description": "Return the internal array being used to store the keys.",
"syntax": [".keys()"],
"returns": "Iterable",
"returns": "Iterable&lt;String&gt;",
"type": "method",
"category": "intdict",
"subcategory": "method",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "values()",
"description": "Return the internal array being used to store the values.",
"syntax": [".values()"],
"returns": "Iterable",
"returns": "Iterable&lt;Integer&gt;",
"type": "method",
"category": "intdict",
"subcategory": "method",
Expand Down
6 changes: 3 additions & 3 deletions content/references/translations/en/processing/IntList.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@
"desc": "Randomize the order of the list elements"
},
{
"anchor": "IntList_array_",
"name": "array()",
"anchor": "IntList_toArray_",
"name": "toArray()",
"desc": "Create a new array with a copy of all the values"
}
],
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
"description": "Helper class for a list of ints. Lists are designed to have some of the\n features of <b>ArrayLists</b>, but to maintain the simplicity and efficiency of\n working with arrays.\n\n Functions like <b>sort()</b> and <b>shuffle()</b> always act on the list itself. To get\n a sorted copy, use <b>list.copy().sort()</b>.",
"description": "Helper class for a list of <b>int</b> values. Lists are designed\n to have some features of <b>ArrayList</b>, but to maintain the\n simplicity and efficiency of working with arrays.\n Functions such as <b>sort()</b> and <b>shuffle()</b> always act on\n the list itself. To get a sorted copy, use <b>list.copy().sort()</b>.",
"type": "class",
"constructors": ["IntList()", "IntList(items)"],
"related": ["FloatList", "StringList"],
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"brief": "Create a new array with a copy of all the values",
"related": [],
"name": "toArray()",
"description": "Create a new array with a copy of all the values.",
"syntax": [".toArray()", ".toArray(array)"],
"returns": "int[]",
"type": "method",
"category": "intlist",
"subcategory": "method",
"classanchor": "IntList",
"parameters": []
}
8 changes: 4 additions & 4 deletions content/references/translations/en/processing/JSONArray.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@
"desc": "Retrieves the <b>JSONObject</b> with the associated index value"
},
{
"anchor": "JSONArray_getStringArray_",
"name": "getStringArray()",
"anchor": "JSONArray_toStringArray_",
"name": "toStringArray()",
"desc": "Returns the entire <b>JSONArray</b> as an array of <b>Strings</b>"
},
{
"anchor": "JSONArray_getIntArray_",
"name": "getIntArray()",
"anchor": "JSONArray_toIntArray_",
"name": "toIntArray()",
"desc": "Returns the entire <b>JSONArray</b> as an array of <b>ints</b>"
},
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"brief": "Returns the entire <b>JSONArray</b> as an array of <b>ints</b>",
"related": [],
"name": "toIntArray()",
"description": "Returns the entire <b>JSONArray</b> as an array of <b>ints</b>. \n (All values in the array must be of the int type.)",
"syntax": [".toIntArray()"],
"returns": "int[]",
"type": "method",
"category": "jsonarray",
"subcategory": "method",
"classanchor": "JSONArray",
"parameters": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"brief": "Returns the entire <b>JSONArray</b> as an array of <b>Strings</b>",
"related": [],
"name": "toStringArray()",
"description": "Returns the entire <b>JSONArray</b> as an array of <b>Strings</b>. \n (All values in the array must be of the <b>String</b> type.)",
"syntax": [".toStringArray()"],
"returns": "String[]",
"type": "method",
"category": "jsonarray",
"subcategory": "method",
"classanchor": "JSONArray",
"parameters": []
}
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
"csspath": "../../",
"isLibrary": "true",
"classFields": [],
"description": "A <b>JSONObject</b> stores JSON data with multiple name/value pairs. Values\n can be numeric, <b>Strings</b>, <b>booleans</b>, other <b>JSONObject</b>s or\n <b>JSONArray</b>s, or null. <b>JSONObject</b> and <b>JSONArray</b> objects\n are quite similar and share most of the same methods; the primary difference\n is that the latter stores an array of JSON objects, while the former\n represents a single JSON object.<br />\n <br />\n JSON can be generated from scratch, dynamically, or using data from an\n existing file. JSON can also be output and saved to disk, as in the example\n above.\n \n ",
"description": "A <b>JSONObject</b> stores JSON data with multiple name/value pairs. Values\n can be numeric, <b>Strings</b>, <b>booleans</b>, other <b>JSONObject</b>s or\n <b>JSONArray</b>s, or null. <b>JSONObject</b> and <b>JSONArray</b> objects\n are quite similar and share most of the same methods; the primary difference\n is that the latter stores an array of JSON objects, while the former\n represents a single JSON object.<br/>\n <br/>\n JSON can be generated from scratch, dynamically, or using data from an\n existing file. JSON can also be output and saved to disk, as in the example\n above.\n \n ",
"type": "class",
"constructors": [],
"related": [
Expand Down
2 changes: 1 addition & 1 deletion content/references/translations/en/processing/PFont.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
],
"name": "PFont",
"classFields": [],
"description": "PFont is the font class for Processing. To create a font to use with\n Processing, select \"Create Font...\" from the Tools menu. This will create a\n font in the format Processing requires and also adds it to the current\n sketch's data directory. Processing displays fonts using the .vlw font\n format, which uses images for each letter, rather than defining them through\n vector data. The <b>loadFont()</b> function constructs a new font and\n <b>textFont()</b> makes a font active. The <b>list()</b> method creates a\n list of the fonts installed on the computer, which is useful information to\n use with the <b>createFont()</b> function for dynamically converting fonts\n into a format to use with Processing.<br />\n <br />\n To create a new font dynamically, use the <b>createFont()</b> function. Do\n not use the syntax <b>new PFont()</b>.\n\n ",
"description": "PFont is the font class for Processing. To create a font to use with\n Processing, select \"Create Font...\" from the Tools menu. This will create a\n font in the format Processing requires and also adds it to the current\n sketch's data directory. Processing displays fonts using the .vlw font\n format, which uses images for each letter, rather than defining them through\n vector data. The <b>loadFont()</b> function constructs a new font and\n <b>textFont()</b> makes a font active. The <b>list()</b> method creates a\n list of the fonts installed on the computer, which is useful information to\n use with the <b>createFont()</b> function for dynamically converting fonts\n into a format to use with Processing.<br/>\n <br/>\n To create a new font dynamically, use the <b>createFont()</b> function. Do\n not use the syntax <b>new PFont()</b>.\n\n ",
"type": "class",
"classanchor": "PFont",
"category": "typography",
Expand Down
Loading