From 446c1965c7469b0457b055e23bbfa100b638a53e Mon Sep 17 00:00:00 2001
From: brutzman <brutzman@nps.edu>
Date: Tue, 17 Aug 2021 10:39:08 -0700
Subject: [PATCH] javadoc improvement
---
examples/src/OpenDis7Examples/EspduSender.java | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/examples/src/OpenDis7Examples/EspduSender.java b/examples/src/OpenDis7Examples/EspduSender.java
index a70a4190c8..c5ca411e16 100644
--- a/examples/src/OpenDis7Examples/EspduSender.java
+++ b/examples/src/OpenDis7Examples/EspduSender.java
@@ -35,13 +35,17 @@ public class EspduSender
* @see <a href="https://en.wikipedia.org/wiki/Port_(computer_networking)">https://en.wikipedia.org/wiki/Port_(computer_networking)</a> */
public static final int DEFAULT_MULTICAST_PORT = 3000;
- /** Type of network connection */
+ /** Type of network connection:
+ * Point to point <a href="https://en.wikipedia.org/wiki/Unicast">UNICAST</a>,
+ * Many to many <a href="https://en.wikipedia.org/wiki/Multicast">MULTICAST</a>, or
+ * (rarely used, potentially harmful) <a href="https://en.wikipedia.org/wiki/Broadcasting_(networking)">BROADCAST</a>
+ */
public enum NetworkMode {
- /** @see <a href="https://en.wikipedia.org/wiki/Unicast">https://en.wikipedia.org/wiki/Unicast</a> */
+ /** Point to point @see <a href="https://en.wikipedia.org/wiki/Unicast">https://en.wikipedia.org/wiki/Unicast</a> */
UNICAST,
- /** @see <a href="https://en.wikipedia.org/wiki/Multicast">https://en.wikipedia.org/wiki/Multicast</a> */
+ /** Many to many @see <a href="https://en.wikipedia.org/wiki/Multicast">https://en.wikipedia.org/wiki/Multicast</a> */
MULTICAST,
- /** @see <a href="https://en.wikipedia.org/wiki/Broadcasting_(networking)">https://en.wikipedia.org/wiki/Broadcasting_(networking)</a> */
+ /** (rarely used, potentially harmful) @see <a href="https://en.wikipedia.org/wiki/Broadcasting_(networking)">https://en.wikipedia.org/wiki/Broadcasting_(networking)</a> */
BROADCAST
};
--
GitLab