Improve javadoc for all addons (#15667)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/SmartMeterBindingConstants.java

@@ -17,7 +17,7 @@ import org.openhab.binding.smartmeter.internal.ObisCode;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link SmlReaderBinding} class defines common constants, which are
+ * The {@link SmartMeterBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Matthias Steigenberger - Initial contribution

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/connectors/IMeterReaderConnector.java

@@ -33,8 +33,9 @@ public interface IMeterReaderConnector<T> {
      * Establishes the connection against the device and reads native encoded SML informations.
      * Ensures that a connection is opened and notifies any attached listeners
      *
-     * @param serialParmeter
+     * @param initMessage
      * @param period hint for the connector to emit items in this time intervals.
+     * @param executor
      * @return native encoded SML informations from a device.
      */
     Publisher<T> getMeterValues(byte @Nullable [] initMessage, Duration period, ExecutorService executor);

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java

@@ -43,7 +43,7 @@ import io.reactivex.schedulers.Schedulers;
 /**
  * This represents a meter device.
  * All read values of the device are cached here and can be obtained. The reading can be started with
- * {@link #readValues(ScheduledExecutorService, Duration)}
+ * {@link #readValues(long, ScheduledExecutorService, Duration)}
  *
  * @author Matthias Steigenberger - Initial contribution
  *
@@ -114,7 +114,7 @@ public abstract class MeterDevice<T> {
     /**
      * Returns the specified OBIS value if available.
      *
-     * @param obis the OBIS code which value should be retrieved.
+     * @param obisId the OBIS code which value should be retrieved.
      * @return the OBIS value as String if available - otherwise null.
      */
     @Nullable
@@ -129,7 +129,7 @@ public abstract class MeterDevice<T> {
     /**
      * Returns the specified OBIS value if available.
      *
-     * @param obis the OBIS code which value should be retrieved.
+     * @param obisId the OBIS code which value should be retrieved.
      * @return the OBIS value if available - otherwise null.
      */
     @SuppressWarnings("unchecked")
@@ -153,8 +153,9 @@ public abstract class MeterDevice<T> {
     /**
      * Read values from this device a store them locally against their OBIS code.
      *
-     * If there is an error in reading, it will be retried {@value #NUMBER_OF_RETRIES} times. The retry will be delayed
-     * by {@code period} seconds.
+     * If there is an error in reading, it will be retried
+     * {@value org.openhab.binding.smartmeter.connectors.ConnectorBase#NUMBER_OF_RETRIES} times.
+     * The retry will be delayed by {@code period} seconds.
      * If its still failing, the connection will be closed and opened again.
      *
      * @return The {@link Disposable} which needs to be disposed whenever not used anymore.

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlMeterReader.java

@@ -48,12 +48,11 @@ public final class SmlMeterReader extends MeterDevice<SmlFile> {
      * Static factory method to create a SmlDevice object with a serial connector member.
      *
      * @param serialPortManagerSupplier
-     *
      * @param deviceId the id of the device as defined in openHAB configuration.
-     * @param pullRequestRequired identicates if SML values have to be actively requested.
      * @param serialPort the port where the device is connected as defined in openHAB configuration.
-     * @param serialParameter
      * @param initMessage
+     * @param baudrate
+     * @param baudrateChangeDelay
      */
     public static SmlMeterReader createInstance(Supplier<SerialPortManager> serialPortManagerSupplier, String deviceId,
             String serialPort, byte @Nullable [] initMessage, int baudrate, int baudrateChangeDelay) {

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlSerialConnector.java

@@ -70,7 +70,6 @@ public final class SmlSerialConnector extends ConnectorBase<SmlFile> {
      *
      * @param portName the port where the device is connected as defined in openHAB configuration.
      * @param baudrate
-     * @throws IOException
      */
     public SmlSerialConnector(Supplier<SerialPortManager> serialPortManagerSupplier, String portName, int baudrate,
             int baudrateChangeDelay) {
@@ -139,7 +138,7 @@ public final class SmlSerialConnector extends ConnectorBase<SmlFile> {
     }
 
     /**
-     * @{inheritDoc}
+     * {@inheritDoc}
      */
     @Override
     public void closeConnection() {

bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlValueExtractor.java

@@ -41,7 +41,7 @@ public final class SmlValueExtractor {
     /**
      * Constructor
      *
-     * @param obis
+     * @param listEntry
      */
     public SmlValueExtractor(SmlListEntry listEntry) {
         smlListEntry = listEntry;