eessppeelllloo/processing4
1
0
Fork 0
mirror of https://github.com/processing/processing4.git synced 2026-05-03 17:35:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Formatting brief descriptions

Browse Source
This commit is contained in:
Anadroid
2021-04-13 16:54:57 +02:00
parent 7b5c8ba9ce
commit 118e22e329
24 changed files with 528 additions and 527 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
java/libraries/io/src/processing/io/I2C.java
View File

@@ -124,7 +124,7 @@ public class I2C {
* time.
*
* @webref I2C
* @webBrief Closes the I2C device.
* @webBrief Closes the I2C device
*/
public void close() {
if (NativeInterface.isSimulated()) {
@@ -155,7 +155,7 @@ public class I2C {
* @see beginTransmission
* @see write
* @webref I2C
* @webBrief Ends the current transmissions.
* @webBrief Ends the current transmissions
*/
public void endTransmission() {
if (!transmitting) {
@@ -223,7 +223,7 @@ public class I2C {
* @see write
* @see endTransmission
* @webref I2C
* @webBrief Read bytes from the attached device.
* @webBrief Read bytes from the attached device
*/
public byte[] read(int len) {
if (!transmitting) {
@@ -261,7 +261,7 @@ public class I2C {
* @see read
* @see endTransmission
* @webref I2C
* @webBrief Add bytes to be written to the device.
* @webBrief Add bytes to be written to the device
*/
public void write(byte[] out) {
if (!transmitting) {

14
java/libraries/net/src/processing/net/Client.java
View File

@@ -37,7 +37,7 @@ import java.net.*;
* listening on a different port, an exception is thrown.
*
* @webref client
* @webBrief The client class is used to create client Objects which connect to a server to exchange data.
* @webBrief The client class is used to create client Objects which connect to a server to exchange data
* @instanceName client any variable of type Client
* @usage Application
* @see_external LIB_net/clientEvent
@@ -321,7 +321,7 @@ public class Client implements Runnable {
*
* @webref client
* @usage application
* @webBrief Returns the IP address of the machine as a String
* @webBrief Returns the IP address of the machine as a <b>String</b>
*/
public String ip() {
if (socket != null){
@@ -422,7 +422,7 @@ public class Client implements Runnable {
*
* @webref client
* @usage application
* @webBrief Reads a group of bytes from the buffer.
* @webBrief Reads a group of bytes from the buffer
*/
public byte[] readBytes() {
synchronized (bufferLock) {
@@ -596,7 +596,7 @@ public class Client implements Runnable {
/**
*
* Returns the all the data from the buffer as a String. This method
* Returns the all the data from the buffer as a <b>String</b>. This method
* assumes the incoming characters are ASCII. If you want to transfer
* Unicode data, first convert the String to a byte stream in the
* representation of your choice (i.e. UTF8 or two-byte Unicode data), and
@@ -604,7 +604,7 @@ public class Client implements Runnable {
*
* @webref client
* @usage application
* @webBrief Returns the buffer as a String
* @webBrief Returns the buffer as a <b>String</b>
*/
public String readString() {
byte b[] = readBytes();
@@ -626,7 +626,7 @@ public class Client implements Runnable {
*
* @webref client
* @usage application
* @webBrief Returns the buffer as a String up to and including a particular character
* @webBrief Returns the buffer as a <b>String</b> up to and including a particular character
* @param interesting character designated to mark the end of the data
*/
public String readStringUntil(int interesting) {
@@ -644,7 +644,7 @@ public class Client implements Runnable {
*
* @webref client
* @usage application
* @webBrief Writes bytes, chars, ints, bytes[], Strings
* @webBrief Writes <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b>
* @param data data to write
*/
public void write(int data) { // will also cover char

10
java/libraries/net/src/processing/net/Server.java
View File

@@ -44,7 +44,7 @@ import java.net.*;
* @webref server
* @usage application
* @webBrief The server class is used to create server objects which send
* and receives data to and from its associated clients (other programs connected to it).
* and receives data to and from its associated clients (other programs connected to it)
* @instanceName server any variable of type Server
*/
public class Server implements Runnable {
@@ -118,7 +118,7 @@ public class Server implements Runnable {
* Disconnect a particular client.
*
* @webref server
* @webBrief Disconnect a particular client.
* @webBrief Disconnect a particular client
* @param client the client to disconnect
*/
public void disconnect(Client client) {
@@ -188,7 +188,7 @@ public class Server implements Runnable {
* into any trouble.
*
* @webref server
* @webBrief Return true if this server is still active.
* @webBrief Return <b>true</b> if this server is still active
*/
public boolean active() {
return thread != null;
@@ -215,7 +215,7 @@ public class Server implements Runnable {
* Returns the next client in line with a new message.
*
* @webref server
* @webBrief Returns the next client in line with a new message.
* @webBrief Returns the next client in line with a new message
* @usage application
*/
public Client available() {
@@ -255,7 +255,7 @@ public class Server implements Runnable {
* is still running. Otherwise, it will be automatically be shut down by the
* host PApplet using dispose(), which is identical.
* @webref server
* @webBrief Disconnects all clients and stops the server.
* @webBrief Disconnects all clients and stops the server
* @usage application
*/
public void stop() {

32
java/libraries/serial/src/processing/serial/Serial.java
View File

@@ -38,7 +38,7 @@ import jssc.*;
* Class for sending and receiving data using the serial communication protocol.
*
* @webref serial
* @webBrief Class for sending and receiving data using the serial communication protocol.
* @webBrief Class for sending and receiving data using the serial communication protocol
* @instanceName serial any variable of type Serial
* @usage Application
* @see_external LIB_serial/serialEvent
@@ -189,7 +189,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_available.xml
* @webref serial
* @webBrief Returns the number of bytes available.
* @webBrief Returns the number of bytes available
* @usage web_application
*/
public int available() {
@@ -215,7 +215,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_bufferUntil.xml
* @webref serial
* @webBrief Sets a specific byte to buffer until before calling <b>serialEvent()</b>.
* @webBrief Sets a specific byte to buffer until before calling <b>serialEvent()</b>
* @usage web_application
* @param inByte the value to buffer until
*/
@@ -230,7 +230,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_clear.xml
* @webref serial
* @webBrief Empty the buffer, removes all the data stored there.
* @webBrief Empty the buffer, removes all the data stored there
* @usage web_application
*/
public void clear() {
@@ -273,7 +273,7 @@ public class Serial implements SerialPortEventListener {
* and clears the buffer. Useful when you just want the most
* recent value sent over the port.
* @webref serial
* @webBrief Returns last byte received or -1 if there is none available.
* @webBrief Returns last byte received or -1 if there is none available
* @usage web_application
*/
public int last() {
@@ -295,7 +295,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_lastChar.xml
* @webref serial
* @webBrief Returns the last byte received as a char or -1 if there is none available.
* @webBrief Returns the last byte received as a char or -1 if there is none available
* @usage web_application
*/
public char lastChar() {
@@ -309,7 +309,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_list.xml
* @webref serial
* @webBrief Gets a list of all available serial ports.
* @webBrief Gets a list of all available serial ports
* @usage web_application
*/
public static String[] list() {
@@ -326,7 +326,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_read.xml
* @webref serial
* @webBrief Returns a number between 0 and 255 for the next byte that's waiting in the buffer.
* @webBrief Returns a number between 0 and 255 for the next byte that's waiting in the buffer
* @usage web_application
*/
public int read() {
@@ -354,7 +354,7 @@ public class Serial implements SerialPortEventListener {
* <b>byteBuffer</b>, only those that fit are read.
* @generate Serial_readBytes.xml
* @webref serial
* @webBrief Reads a group of bytes from the buffer or <b>null</b> if there are none available.
* @webBrief Reads a group of bytes from the buffer or <b>null</b> if there are none available
* @usage web_application
*/
public byte[] readBytes() {
@@ -446,7 +446,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_readBytesUntil.xml
* @webref serial
* @webBrief Reads from the port into a buffer of bytes up to and including a particular character.
* @webBrief Reads from the port into a buffer of bytes up to and including a particular character
* @usage web_application
* @param inByte character designated to mark the end of the data
*/
@@ -532,7 +532,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_readChar.xml
* @webref serial
* @webBrief Returns the next byte in the buffer as a char.
* @webBrief Returns the next byte in the buffer as a char
* @usage web_application
*/
public char readChar() {
@@ -541,14 +541,14 @@ public class Serial implements SerialPortEventListener {
/**
* Returns all the data from the buffer as a String or <b>null</b> if there is nothing available.
* Returns all the data from the buffer as a <b>String</b> or <b>null</b> if there is nothing available.
* This method assumes the incoming characters are ASCII. If you want to transfer Unicode data,
* first convert the String to a byte stream in the representation of your choice (i.e. UTF8 or
* two-byte Unicode data), and send it as a byte array.
*
* @generate Serial_readString.xml
* @webref serial
* @webBrief Returns all the data from the buffer as a String or <b>null</b> if there is nothing available.
* @webBrief Returns all the data from the buffer as a <b>String</b> or <b>null</b> if there is nothing available
* @usage web_application
*/
public String readString() {
@@ -570,7 +570,7 @@ public class Serial implements SerialPortEventListener {
* (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.
*
* @webref serial
* @webBrief Combination of <b>readBytesUntil()</b> and <b>readString()</b>.
* @webBrief Combination of <b>readBytesUntil()</b> and <b>readString()</b>
* @usage web_application
* @param inByte character designated to mark the end of the data
*/
@@ -594,7 +594,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate serialEvent.xml
* @webref serial_event
* @webBrief Called when data is available.
* @webBrief Called when data is available
* @usage web_application
* @param event the port where new data is available
*/
@@ -679,7 +679,7 @@ public class Serial implements SerialPortEventListener {
*
* @generate Serial_stop.xml
* @webref serial
* @webBrief Stops data communication on this port.
* @webBrief Stops data communication on this port
* @usage web_application
*/
public void stop() {