Skip to content

Commit 020c23c

Browse files
committed
Improve Network and Serial library web reference
- fix broken `@see_external` webref links (remove outdated LIB_ prefix) - adjust `@instanceName`s and descriptions to match the webref example variable names
1 parent e7d2e5b commit 020c23c

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

java/libraries/net/src/processing/net/Client.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@
3939
*
4040
* @webref client
4141
* @webBrief The client class is used to create client Objects which connect to a server to exchange data
42-
* @instanceName client any variable of type Client
4342
* @usage Application
44-
* @see_external LIB_net/clientEvent
43+
* @see_external clientEvent
4544
*/
4645
@SuppressWarnings("unused")
4746
public class Client implements Runnable {

java/libraries/serial/src/processing/serial/Serial.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
*
4040
* @webref serial
4141
* @webBrief Class for sending and receiving data using the serial communication protocol
42-
* @instanceName serial any variable of type Serial
42+
* @instanceName myPort your Serial object
4343
* @usage Application
44-
* @see_external LIB_serial/serialEvent
44+
* @see_external serialEvent
4545
*/
4646
public class Serial implements SerialPortEventListener {
4747
PApplet parent;

0 commit comments

Comments
 (0)