Improve javadoc syntax

Author: Jonas

src/main/java/io/github/joblo2213/sma/speedwire/Speedwire.java

@@ -16,17 +16,17 @@
 /**
  * <p>
  * Main class for interacting with speedwire devices.
- * </p><br><p>
+ * </p><p>
  * All devices that use the speedwire protocol send data periodically via
  * <a href="https://en.wikipedia.org/wiki/User_Datagram_Protocol">UDP</a>
  * <a href="https://en.wikipedia.org/wiki/Multicast">Multicast</a>, by default to group {@code 239.12.255.254}
  * on port {@code 9522}.
- * </p><br><p>
+ * </p><p>
  * To join the multicast group and listen for incoming data call the {@code start()} method.<br>
  * The thread will read all incoming data and parse the telegrams.<br>
  * Register callbacks that receive the parsed telegrams from the thread by using {@code onData()}.<br>
  * Callbacks that handle occurring errors or timeouts can also be registered but aren't mandatory.<br>
- * </p><br><p>
+ * </p><p>
  * <b>Example:</b>
  * </p><pre>{@code
  * Speedwire sw = new Speedwire();
@@ -129,7 +129,7 @@ private static InetAddress getLocalAddress() throws IOException {
      * Callbacks are allowed to be registered while the speedwire thread is running, although it is advised to register
      * them before calling {@code start()}.<br>
      * The callback will be run on the speedwire thread so avoid blocking or very slow operations.
-     * </p><br><p>
+     * </p><p>
      * <b>Note:</b><br>
      * Telegrams send from your host address will be redirected back by the multicast group and are therefore
      * filtered out. They will not trigger this callback.
@@ -183,7 +183,7 @@ public void send(byte[] packet) {
      * Every speedwire device will answer this request with a {@link DiscoveryResponse} for which you can listen
      * using {@code onData()}.<br>
      * This allows detecting all unknown devices and determining their ip addresses by using {@link Telegram#getOrigin()}.
-     * </p><br><p>
+     * </p><p>
      * More information on speedwire device discovery can be found in
      * <a href="https://www.sma.de/fileadmin/content/global/Partner/Documents/sma_developer/SpeedwireDD-TI-en-10.pdf">
      * SpeedwireDD-TI-en-10.pdf

src/main/java/io/github/joblo2213/sma/speedwire/SpeedwireCallback.java

@@ -5,13 +5,15 @@
 /**
  * <p>
  * The callback that is run on any received data packets over sma speedwire.
- * </p><br><p>
+ * </p><p>
  * If you want to listen for specific telegrams or parse special data, check if the provided data is of a
  * specific subclass of telegram.
- * </p><br><p>
+ * </p><p>
  * Currently implemented telegrams:<br>
- * {@link DiscoveryResponse}, {@link EnergyMeterTelegram}
- * </p><br><p>
+ * <ul>
+ *     <li>{@link DiscoveryResponse}</li>
+ *     <li>{@link EnergyMeterTelegram}</li>
+ * </ul></p><p>
  * <b>Example:</b>
  * <pre>{@code
  * speedwire.onData(data -> {

src/main/java/io/github/joblo2213/sma/speedwire/SpeedwireErrorHandler.java

@@ -9,17 +9,18 @@
 /**
  * <p>
  * The callback that is run on any occurring exceptions while reading incoming packets from sma speedwire.
- * </p><br><p>
+ * </p><p>
  * If you want to listen for specific types of exceptions, check the type with {@code instanceof}.
- * </p><br><p>
+ * </p><p>
  * Likely exceptions are:<br>
- * {@link TelegramInvalidException} - if an incoming packet can't be parsed as valid speedwire telegram
- * {@link IOException} – if an I/O error occurs.<br>
- * {@link PortUnreachableException} –   may be thrown if the socket is connected to a currently unreachable destination.
- * Note, there is no guarantee that the exception will be thrown.<br>
- * {@link IllegalBlockingModeException} –   if the socket has an associated channel,
- * and the channel is in non-blocking mode.<br>
- * </p><br><p>
+ * <ul>
+ * <li>{@link TelegramInvalidException} - if an incoming packet can't be parsed as valid speedwire telegram</li>
+ * <li>{@link IOException} – if an I/O error occurs.</li>
+ * <li>{@link PortUnreachableException} –   may be thrown if the socket is connected to a currently unreachable destination.
+ * Note, there is no guarantee that the exception will be thrown.</li>
+ * <li>{@link IllegalBlockingModeException} –   if the socket has an associated channel,
+ * and the channel is in non-blocking mode.</li>
+ * </ul></p><p>
  * <b>Example:</b>
  * <pre>{@code
  * speedwire.onError(e -> {

src/main/java/io/github/joblo2213/sma/speedwire/protocol/OBISIdentifier.java

@@ -6,14 +6,15 @@
  * <p>
  * OBIS identifiers are used to identify measurement values in a telegram.<br>
  * They are defined in the <b>ICE 62056-61</b> standard.
- * </p><br><p>
+ * </p><p>
  * Each OBIS identifier consists of the following groups:<br>
- * <i><b>Group A</b> - specifies the medium (1 = electricity)</i> <b>omitted</b><br>
- * <b>Group B</b> - specifies the channel (default 0)<br>
- * <b>Group C</b> - specifies the index of the physical value<br>
- * <b>Group D</b> - specifies the type of measurement<br>
- * <b>Group E</b> - specifies the tariff (default 0)<br>
- * </p>
+ * <ul>
+ *     <li><i><b>Group A</b> - specifies the medium (1 = electricity)</i> <b>omitted</b></li>
+ *     <li><b>Group B</b> - specifies the channel (default 0)</li>
+ *     <li><b>Group C</b> - specifies the index of the physical value</li>
+ *     <li><b>Group D</b> - specifies the type of measurement</li>
+ *     <li><b>Group E</b> - specifies the tariff (default 0)</li>
+ * </ul></p>
  */
 public class OBISIdentifier {
 
@@ -45,7 +46,7 @@ public OBISIdentifier(byte[] data) {
      * <b>OBIS group B</b><br>
      * Some devices have multiple measurement channels that generate multiple measurement results for the same index.<br>
      * These devices can separate the results into different channels.
-     * </p><br><p>
+     * </p><p>
      * SMA Devices initially use channel 0 for internal measurements and can use additional channels for additional
      * connected circuits.
      * </p>
@@ -98,7 +99,7 @@ public int getDataLength() {
     /**
      * <p>
      * Returns the identifier as String with the syntax B:C.D.E
-     * </p><br><p>
+     * </p><p>
      * <b>Example:</b> {@code 0:14.4.0} (net frequency)
      * </p>
      */

src/main/java/io/github/joblo2213/sma/speedwire/protocol/telegrams/EnergyMeterTelegram.java

@@ -97,7 +97,7 @@ private void loadMeasurements(int from, int to) throws TelegramInvalidException
     /**
      * <p>
      * Returns the devices SUSy ID.
-     * </p><br><p>
+     * </p><p>
      * The SUSy ID is a 2 byte long (unsigned) identifier of SMA hardware, located in the first two bytes of a devices
      * SMA device address.
      * </p>
@@ -124,7 +124,7 @@ public Quantity<Time> getMeasuringTime() {
     /**
      * <p>
      * Returns the software version string of the smart meter
-     * </p><br><p>
+     * </p><p>
      * Syntax:<br>
      * <center><b>Major.Minor.Build.Revision</b></center><br>
      * </p>

src/main/java/io/github/joblo2213/sma/speedwire/protocol/telegrams/Telegram.java

@@ -31,7 +31,7 @@ public class Telegram {
      * Parses the given datagram packet into a telegram<br>
      * The returned telegram will be of a specific subclass if the data from the packet matches the subclasses
      * requirements.
-     * </p><br><p>
+     * </p><p>
      * Currently implemented subclasses:<br>
      * {@link DiscoveryResponse}, {@link EnergyMeterTelegram}
      * </p>
@@ -110,7 +110,7 @@ public int length() {
     /**
      * <p>
      * Returns the raw value from the specified position of the telegrams data
-     * </p><br><p>
+     * </p><p>
      * <b>Telegrams contain unsigned bytes while java byte is signed.<br>
      * It's in most cases better to use {@link #getUnsigned(int)}!</b>
      * </p>
@@ -135,7 +135,7 @@ public int getUnsigned(int index) {
     /**
      * <p>
      * Returns an array of multiple bytes from the telegrams data
-     * </p><br><p>
+     * </p><p>
      * <b>Telegrams contain unsigned bytes while java byte is signed.<br>
      * It's in most cases better to use {@link #getUnsigned(int, int)}!</b>
      * </p>