From 54ad37eb2711050dbf90dc9c732710fd6c68bd11 Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Mon, 11 Sep 2023 15:36:37 +0200 Subject: [PATCH 1/2] Fix Network and Serial library @see_external links to work with new web reference. Known issue: the link to serialEvent_.html is still broken because the target documentation is actually created at Serial_serialEvent_.html based on an internal library function that calls the user-defined `serialEvent()` function that the documentation is actually for. Either this file needs to be moved after generation, or alternatively the documentation could be moved from the Javadoc to a static JSON file (this is also how it is done for the Network library callback) --- java/libraries/net/src/processing/net/Client.java | 2 +- java/libraries/serial/src/processing/serial/Serial.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/java/libraries/net/src/processing/net/Client.java b/java/libraries/net/src/processing/net/Client.java index 048c6799b..d6d29e40d 100644 --- a/java/libraries/net/src/processing/net/Client.java +++ b/java/libraries/net/src/processing/net/Client.java @@ -41,7 +41,7 @@ * @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..d15bc5ad1 100644 --- a/java/libraries/serial/src/processing/serial/Serial.java +++ b/java/libraries/serial/src/processing/serial/Serial.java @@ -41,7 +41,7 @@ * @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 + * @see_external serialEvent */ public class Serial implements SerialPortEventListener { PApplet parent; From d88715887b5f2de32f6069e488e48e3104f81b33 Mon Sep 17 00:00:00 2001 From: kevinstadler Date: Mon, 11 Sep 2023 15:44:25 +0200 Subject: [PATCH 2/2] Let processing/processing-doclet#6 choose an approriate @instanceName Closes processing/processing-website#397 --- java/libraries/serial/src/processing/serial/Serial.java | 1 - 1 file changed, 1 deletion(-) diff --git a/java/libraries/serial/src/processing/serial/Serial.java b/java/libraries/serial/src/processing/serial/Serial.java index d15bc5ad1..467f4e4dc 100644 --- a/java/libraries/serial/src/processing/serial/Serial.java +++ b/java/libraries/serial/src/processing/serial/Serial.java @@ -39,7 +39,6 @@ * * @webref serial * @webBrief Class for sending and receiving data using the serial communication protocol - * @instanceName serial any variable of type Serial * @usage Application * @see_external serialEvent */