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
This commit is contained in:
kevinstadler
2024-04-13 18:26:44 -06:00
parent e7d2e5b403
commit 020c23c9f1
2 changed files with 3 additions and 4 deletions
@@ -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 {
@@ -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;