From 020c23c9f1ed8d0835957ad2631009268dd972c6 Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Sat, 13 Apr 2024 18:26:44 -0600 Subject: [PATCH] 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 --- java/libraries/net/src/processing/net/Client.java | 3 +-- java/libraries/serial/src/processing/serial/Serial.java | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/java/libraries/net/src/processing/net/Client.java b/java/libraries/net/src/processing/net/Client.java index 048c6799b..a915660b1 100644 --- a/java/libraries/net/src/processing/net/Client.java +++ b/java/libraries/net/src/processing/net/Client.java @@ -39,9 +39,8 @@ import java.nio.charset.StandardCharsets; * * @webref client * @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 + * @see_external clientEvent */ @SuppressWarnings("unused") public class Client implements Runnable { diff --git a/java/libraries/serial/src/processing/serial/Serial.java b/java/libraries/serial/src/processing/serial/Serial.java index a0b5f8462..15ed23fcd 100644 --- a/java/libraries/serial/src/processing/serial/Serial.java +++ b/java/libraries/serial/src/processing/serial/Serial.java @@ -39,9 +39,9 @@ import jssc.*; * * @webref serial * @webBrief Class for sending and receiving data using the serial communication protocol - * @instanceName serial any variable of type Serial + * @instanceName myPort your Serial object * @usage Application - * @see_external LIB_serial/serialEvent + * @see_external serialEvent */ public class Serial implements SerialPortEventListener { PApplet parent;