Skip to content

Commit 7dee301

Browse files
authored
Merge pull request #457 from processing/updated-documentation-with-doclet
Reference updated with new JSON files after switch to JDK 17
2 parents c546ab2 + 6ea6cc7 commit 7dee301

File tree

399 files changed

+741
-546
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

399 files changed

+741
-546
lines changed

content/references/translations/en/io/SPI_settings_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
},
2323
{
2424
"name": "mode",
25-
"description": "<a href=\n \"https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase\">SPI.MODE0\n to SPI.MODE3</a>",
25+
"description": "<a href=\"https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Clock_polarity_and_phase\">,SPI.MODE0\n to SPI.MODE3,</a>",
2626
"type": ["int"]
2727
}
2828
]

content/references/translations/en/net/Client.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
"csspath": "../../",
6666
"isLibrary": "true",
6767
"classFields": [],
68-
"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.",
68+
"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.",
6969
"type": "class",
7070
"constructors": ["Client(parent, host, port)", "Client(parent, socket)"],
7171
"related": ["LIB_net/clientEvent_"],

content/references/translations/en/net/Client_available_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns the number of bytes in the buffer waiting to be read",
33
"related": [],
44
"name": "available()",
5-
"description": "Returns the number of bytes available. When any client has bytes \n available from the server, it returns the number of bytes.",
5+
"description": "Returns the number of bytes available. When any client has bytes\n available from the server, it returns the number of bytes.",
66
"syntax": ["client.available()"],
77
"returns": "int",
88
"type": "method",

content/references/translations/en/net/Client_readBytesUntil_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Reads from the buffer of bytes up to and including a particular character",
33
"related": [],
44
"name": "readBytesUntil()",
5-
"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.",
5+
"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.",
66
"syntax": [
77
"client.readBytesUntil(interesting)",
88
"client.readBytesUntil(interesting, byteBuffer)"

content/references/translations/en/net/Client_readBytes_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Reads a group of bytes from the buffer",
33
"related": [],
44
"name": "readBytes()",
5-
"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 ",
5+
"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 ",
66
"syntax": [
77
"client.readBytes()",
88
"client.readBytes(max)",

content/references/translations/en/net/Client_readChar_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns the next byte in the buffer as a char",
33
"related": [],
44
"name": "readChar()",
5-
"description": "Returns the next byte in the buffer as a char. Returns <b>-1</b> or \n <b>0xffff</b> if nothing is there.",
5+
"description": "Returns the next byte in the buffer as a char. Returns <b>-1</b> or\n <b>0xffff</b> if nothing is there.",
66
"syntax": ["client.readChar()"],
77
"returns": "char",
88
"type": "method",

content/references/translations/en/net/Client_readStringUntil_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns the buffer as a <b>String</b> up to and including a particular character",
33
"related": [],
44
"name": "readStringUntil()",
5-
"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 ",
5+
"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 ",
66
"syntax": ["client.readStringUntil(interesting)"],
77
"returns": "String",
88
"type": "method",

content/references/translations/en/net/Client_readString_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns the buffer as a <b>String</b>",
33
"related": [],
44
"name": "readString()",
5-
"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.",
5+
"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.",
66
"syntax": ["client.readString()"],
77
"returns": "String",
88
"type": "method",

content/references/translations/en/net/Client_read_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Returns a value from the buffer",
33
"related": [],
44
"name": "read()",
5-
"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.",
5+
"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.",
66
"syntax": ["client.read()"],
77
"returns": "int",
88
"type": "method",

content/references/translations/en/net/Client_stop_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"brief": "Disconnects from the server",
33
"related": [],
44
"name": "stop()",
5-
"description": "Disconnects from the server. Use to shut the connection when you're \n finished with the Client.",
5+
"description": "Disconnects from the server. Use to shut the connection when you're\n finished with the Client.",
66
"syntax": ["client.stop()"],
77
"returns": "void",
88
"type": "method",

0 commit comments

Comments
 (0)