Improve javadoc for all addons (#15667)

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

bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyScriptEngineConfiguration.java

@@ -274,7 +274,7 @@ public class JRubyScriptEngineConfiguration {
     /**
      * Configure the optional elements of the Ruby Environment
      * 
-     * @param engine Engine in which to configure environment
+     * @param scriptEngine Engine in which to configure environment
      */
     public void configureRubyEnvironment(ScriptEngine scriptEngine) {
         getConfigurationElements(OptionalConfigurationElement.Type.RUBY_ENVIRONMENT).forEach(configElement -> {

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java

@@ -67,7 +67,6 @@ public abstract class AbstractScriptExtensionProvider implements ScriptExtension
 
     @Override
     public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException {
-
         Map<String, Object> forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>());
         return forScript.computeIfAbsent(type,
                 k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null);

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java

@@ -68,7 +68,6 @@ public abstract class ScriptDisposalAwareScriptExtensionProvider
 
     @Override
     public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException {
-
         Map<String, Object> forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>());
         return forScript.computeIfAbsent(type,
                 k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null);

bundles/org.openhab.binding.adorne/src/main/java/org/openhab/binding/adorne/internal/hub/AdorneHubChangeNotify.java

@@ -25,7 +25,7 @@ public interface AdorneHubChangeNotify {
     /**
      * Notify listener about state change of on/off and brightness state
      *
-     * @param zoneID zone ID for which change occurred
+     * @param zoneId zone ID for which change occurred
      * @param onOff new on/off state
      * @param brightness new brightness
      */

bundles/org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java

@@ -67,7 +67,7 @@ import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 
 /**
- * The {@link $AirqHandler} is responsible for retrieving all information from the air-Q device
+ * The {@link AirqHandler} is responsible for retrieving all information from the air-Q device
  * and change properties and channels accordingly.
  *
  * @author Aurelio Caliaro - Initial contribution

bundles/org.openhab.binding.airquality/src/main/java/org/openhab/binding/airquality/internal/AirQualityBindingConstants.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link AirQualityBinding} class defines common constants, which are
+ * The {@link AirQualityBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Gaël L'hopital - Initial contribution

bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/protocol/ADCommand.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 
 /**
- * The {@link ADCCommand} class represents an alarm decoder command, and contains the static methods and definitions
+ * The {@link ADCommand} class represents an alarm decoder command, and contains the static methods and definitions
  * used to construct one. Not all supported AD commands are necessarily used by the current binding.
  *
  * @author Bob Adair - Initial contribution

bundles/org.openhab.binding.allplay/src/main/java/org/openhab/binding/allplay/internal/AllPlayBindingConstants.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link AllPlayBinding} class defines common constants, which are
+ * The {@link AllPlayBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Dominic Lerbs - Initial contribution

bundles/org.openhab.binding.amazondashbutton/src/main/java/org/openhab/binding/amazondashbutton/internal/capturing/PacketCapturingHandler.java

@@ -24,7 +24,7 @@ public interface PacketCapturingHandler {
     /**
      * Callback method to handle a captured packet.
      *
-     * @param macAddress The mac address which sent the packet
+     * @param sourceMacAddress The mac address which sent the packet
      */
     void packetCaptured(MacAddress sourceMacAddress);
 }

bundles/org.openhab.binding.amazonechocontrol/src/main/java/org/openhab/binding/amazonechocontrol/internal/handler/EchoHandler.java

@@ -390,7 +390,6 @@ public class EchoHandler extends BaseThingHandler implements IEchoThingHandler {
             // shuffle command
             if (channelId.equals(CHANNEL_SHUFFLE)) {
                 if (command instanceof OnOffType value) {
-
                     connection.command(device, "{\"type\":\"ShuffleCommand\",\"shuffle\":\""
                             + (value == OnOffType.ON ? "true" : "false") + "\"}");
                 }

bundles/org.openhab.binding.androidtv/src/main/java/org/openhab/binding/androidtv/internal/protocol/googletv/GoogleTVConnectionManager.java

@@ -380,7 +380,6 @@ public class GoogleTVConnectionManager {
                 }
                 androidtvPKI.setCaCert(shimX509ClientChain[0]);
                 androidtvPKI.saveKeyStore(config.keystorePassword, this.encryptionKey);
-
             }
         } catch (Exception e) {
             logger.trace("setShimX509ClientChain Exception", e);

bundles/org.openhab.binding.anthem/src/main/java/org/openhab/binding/anthem/internal/handler/AnthemCommand.java

@@ -17,7 +17,7 @@ import static org.openhab.binding.anthem.internal.AnthemBindingConstants.COMMAND
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * The {@link AnthemCommend} is responsible for creating commands to be sent to the
+ * The {@link AnthemCommand} is responsible for creating commands to be sent to the
  * Anthem processor.
  *
  * @author Mark Hilbush - Initial contribution

bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/AstroBindingConstants.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link AstroBinding} class defines common constants, which are
+ * The {@link AstroBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Gerhard Riegler - Initial contribution

bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/handler/AstroThingHandler.java

@@ -294,8 +294,6 @@ public abstract class AstroThingHandler extends BaseThingHandler {
 
     /**
      * Adds the provided {@link Job} to the queue (cannot be {@code null})
-     *
-     * @return {@code true} if the {@code job} is added to the queue, otherwise {@code false}
      */
     public void schedule(Job job, Calendar eventAt) {
         long sleepTime;

bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtHttpClient.java

@@ -62,7 +62,7 @@ public class AsuswrtHttpClient {
     /**
      * Sends a synchronous HTTP request.
      *
-     * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
+     * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
      * {@link #handleHttpResultError(Throwable)}.
      *
      * If the response should be returned use {@link #getSyncRequest(String, String)} instead.
@@ -106,7 +106,7 @@ public class AsuswrtHttpClient {
     /**
      * Sends an asynchronous HTTP request so it does not wait for an answer.
      *
-     * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
+     * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
      * {@link #handleHttpResultError(Throwable)}.
      *
      * @param url the URL to which the request is sent to

bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java

@@ -39,7 +39,7 @@ public class AsuswrtErrorHandler {
     /**
      * Raises a new error.
      *
-     * @param exception the exception
+     * @param ex the exception
      */
     public void raiseError(Exception ex) {
         raiseError(ex, "");
@@ -48,7 +48,7 @@ public class AsuswrtErrorHandler {
     /**
      * Raises a new error.
      *
-     * @param exception the exception
+     * @param ex the exception
      * @param infoMessage optional info message
      */
     public void raiseError(Exception ex, @Nullable String infoMessage) {

bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/structures/AsuswrtIpInfo.java

@@ -46,7 +46,7 @@ public class AsuswrtIpInfo {
     /**
      * Constructor.
      *
-     * @param interfaceName name of interface
+     * @param ifName name of interface
      * @param jsonObject with ipInfo
      */
     public AsuswrtIpInfo(String ifName, JsonObject jsonObject) {

bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/things/AsuswrtRouter.java

@@ -393,7 +393,7 @@ public class AsuswrtRouter extends BaseBridgeHandler {
     /**
      * Fire Event
      *
-     * @param channelUID chanelUID event belongs to
+     * @param channel chanelUID event belongs to
      * @param event event-name is fired
      */
     protected void fireEvent(String channel, String event) {

bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaBindingConstants.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link AtlonaBinding} class defines common constants, which are used across the whole binding.
+ * The {@link AtlonaBindingConstants} class defines common constants, which are used across the whole binding.
  *
  * @author Tim Roberts - Initial contribution
  * @author Michael Lobstein - Add support for AT-PRO3HD 44/66 M

bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaHandlerCallback.java

@@ -20,14 +20,16 @@ import org.openhab.core.types.State;
 
 /**
  *
- * A callback to {@link AtlonaHandler} that can be used to update the status, properties and state of the thing.
+ * A callback to {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+ * that can be used to update the status, properties and state of the thing.
  *
  * @author Tim Roberts - Initial contribution
  */
 @NonNullByDefault
 public interface AtlonaHandlerCallback {
     /**
-     * Callback to the {@link AtlonaHandler} to update the status of the thing.
+     * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+     * to update the status of the thing.
      *
      * @param status a non-null {@link org.openhab.core.thing.ThingStatus}
      * @param detail a non-null {@link org.openhab.core.thing.ThingStatusDetail}
@@ -36,15 +38,17 @@ public interface AtlonaHandlerCallback {
     void statusChanged(ThingStatus status, ThingStatusDetail detail, @Nullable String msg);
 
     /**
-     * Callback to the {@link AtlonaHandler} to update the state of an item
+     * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+     * to update the state of an item
      *
      * @param channelId the non-null, non-empty channel id
-     * @param state the new non-null {@State}
+     * @param state the new non-null {@link State}
      */
     void stateChanged(String channelId, State state);
 
     /**
-     * Callback to the {@link AtlonaHandler} to update the property of a thing
+     * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+     * to update the property of a thing
      *
      * @param propertyName a non-null, non-empty property name
      * @param propertyValue a non-null, possibly empty property value

bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Config.java

@@ -20,7 +20,8 @@ package org.openhab.binding.atlona.internal.pro3;
 public class AtlonaPro3Config {
 
     /**
-     * Constant field used in {@link AtlonaDiscovery} to set the config property during discovery. Value of this field
+     * Constant field used in {@link org.openhab.binding.atlona.internal.discovery.AtlonaDiscovery}
+     * to set the config property during discovery. Value of this field
      * needs to match {@link #ipAddress}
      */
     public static final String IP_ADDRESS = "ipAddress";

bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Handler.java

@@ -116,7 +116,8 @@ public class AtlonaPro3Handler extends AtlonaHandler<AtlonaPro3Capabilities> {
      * Handles commands to specific channels. This implementation will offload much of its work to the
      * {@link AtlonaPro3PortocolHandler}. Basically we validate the type of command for the channel then call the
      * {@link AtlonaPro3PortocolHandler} to handle the actual protocol. Special use case is the {@link RefreshType}
-     * where we call {{@link #handleRefresh(String)} to handle a refresh of the specific channel (which in turn calls
+     * where we call {{@link #handleRefresh(ChannelUID)} to handle a refresh of the specific channel (which in turn
+     * calls
      * {@link AtlonaPro3PortocolHandler} to handle the actual refresh
      */
     @Override

bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/AutelisBindingConstants.java

@@ -21,7 +21,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link AutelisBinding} class defines common constants, which are used
+ * The {@link AutelisBindingConstants} class defines common constants, which are used
  * across the whole binding.
  *
  * @author Dan Cunningham - Initial contribution

bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/AutomowerBindingConstants.java

@@ -23,7 +23,7 @@ import org.openhab.core.thing.ThingTypeUID;
  * used across the whole binding.
  *
  * @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
  */
 @NonNullByDefault
 public class AutomowerBindingConstants {

bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Calendar.java

@@ -17,7 +17,7 @@ import java.util.List;
 
 /**
  * @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
  */
 public class Calendar {
     private List<CalendarTask> tasks = new ArrayList<>();

bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Planner.java

@@ -14,7 +14,7 @@ package org.openhab.binding.automower.internal.rest.api.automowerconnect.dto;
 
 /**
  * @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
  */
 public class Planner {
     private long nextStartTimestamp;

bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java

@@ -68,7 +68,7 @@ import com.google.gson.Gson;
  * sent to one of the channels.
  *
  * @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
  */
 @NonNullByDefault
 public class AutomowerHandler extends BaseThingHandler {

bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/ColorControlModel.java

@@ -47,7 +47,7 @@ public class ColorControlModel {
     /**
      * Converts a FRITZ!Box value to a percent value.
      *
-     * @param fritzValue The FRITZ!Box value to be converted
+     * @param saturation The FRITZ!Box value to be converted
      * @return The percent value
      */
     public static PercentType toPercent(int saturation) {

bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/ApplyMaskListModel.java

@@ -17,7 +17,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
- * See {@ TemplateModel}.
+ * See {@link TemplateModel}.
  *
  * @author Christoph Weitkamp - Initial contribution
  */

bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/DeviceListModel.java

@@ -21,7 +21,7 @@ import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
- * See {@ TemplateModel}.
+ * See {@link TemplateModel}.
  *
  * @author Christoph Weitkamp - Initial contribution
  */

bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/callbacks/FritzAhaSetLevelPercentageCallback.java

@@ -38,7 +38,7 @@ public class FritzAhaSetLevelPercentageCallback extends FritzAhaReauthCallback {
      *
      * @param webIface Interface to FRITZ!Box
      * @param ain AIN of the device that should be switched
-     * @param level Opening level percentage (0 ... 100)
+     * @param levelPercentage Opening level percentage (0 ... 100)
      */
     public FritzAhaSetLevelPercentageCallback(FritzAhaWebInterface webIface, String ain, BigDecimal levelPercentage) {
         super(WEBSERVICE_PATH, "switchcmd=setlevelpercentage&level=" + levelPercentage + "&ain=" + ain, webIface, GET,

bundles/org.openhab.binding.benqprojector/src/main/java/org/openhab/binding/benqprojector/internal/handler/BenqProjectorHandler.java

@@ -49,7 +49,7 @@ import org.slf4j.LoggerFactory;
  * The {@link BenqProjectorHandler} is responsible for handling commands, which are
  * sent to one of the channels.
  *
- * Based on 'epsonprojector' originally by Pauli Anttila & Yannick Schaus
+ * Based on 'epsonprojector' originally by Pauli Anttila and Yannick Schaus
  *
  * @author Michael Lobstein - Initial contribution
  */

bundles/org.openhab.binding.bluetooth.airthings/src/main/java/org/openhab/binding/bluetooth/airthings/internal/AirthingsConfiguration.java

@@ -15,7 +15,7 @@ package org.openhab.binding.bluetooth.airthings.internal;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * Configuration class for {@link AirthingsBinding} device.
+ * Configuration class for Airthings device.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/BlueGigaBluetoothDevice.java

@@ -58,7 +58,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * An extended {@link BluetoothDevice} class to handle BlueGiga specific information
+ * An extended {@link BaseBluetoothDevice} class to handle BlueGiga specific information
  *
  * @author Chris Jackson - Initial contribution
  */
@@ -130,7 +130,7 @@ public class BlueGigaBluetoothDevice extends BaseBluetoothDevice implements Blue
     };
 
     /**
-     * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BluetoothDevice} for the BlueGiga
+     * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BaseBluetoothDevice} for the BlueGiga
      * implementation
      *
      * @param bgHandler the {@link BlueGigaBridgeHandler} that provides the link to the dongle

bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/handler/BlueGigaBridgeHandler.java

@@ -781,7 +781,6 @@ public class BlueGigaBridgeHandler extends AbstractBluetoothBridgeHandler<BlueGi
     public void bluegigaEventReceived(@Nullable BlueGigaResponse event) {
         if (event instanceof BlueGigaScanResponseEvent scanEvent) {
             if (initComplete) {
-
                 // We use the scan event to add any devices we hear to the devices list
                 // The device gets created, and then manages itself for discovery etc.
                 BluetoothAddress sender = new BluetoothAddress(scanEvent.getSender());

bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/BlueGigaTransactionManager.java

@@ -142,7 +142,7 @@ public class BlueGigaTransactionManager implements BlueGigaSerialEventListener {
      * FIFO queue. This method queues a {@link BlueGigaCommand} frame without
      * waiting for a response.
      *
-     * @param transaction
+     * @param request
      *            {@link BlueGigaUniqueCommand}
      */
     public void queueFrame(BlueGigaUniqueCommand request) {
@@ -245,7 +245,6 @@ public class BlueGigaTransactionManager implements BlueGigaSerialEventListener {
 
                 if (bleCommand instanceof BlueGigaDeviceCommand devCommand
                         && bleResponse instanceof BlueGigaDeviceResponse devResponse) {
-
                     logger.trace("Expected connection id: {}, received connection id: {}", devCommand.getConnection(),
                             devResponse.getConnection());
 

bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirDataType.java

@@ -85,7 +85,7 @@ public enum EirDataType {
     /**
      * Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
      *
-     * @param bluetoothAddressType
+     * @param eirDataType
      *            the code to lookup
      * @return enumeration value.
      */

bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirFlags.java

@@ -59,7 +59,7 @@ public enum EirFlags {
     /**
      * Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
      *
-     * @param bluetoothAddressType
+     * @param eirFlag
      *            the code to lookup
      * @return enumeration value.
      */

bundles/org.openhab.binding.bluetooth.bluez/src/main/java/org/openhab/binding/bluetooth/bluez/internal/BlueZBluetoothDevice.java

@@ -77,7 +77,6 @@ public class BlueZBluetoothDevice extends BaseBluetoothDevice implements BlueZEv
      *
      * @param adapter the bridge handler through which this device is connected
      * @param address the Bluetooth address of the device
-     * @param name the name of the device
      */
     public BlueZBluetoothDevice(BlueZBridgeHandler adapter, BluetoothAddress address) {
         super(adapter, address);

bundles/org.openhab.binding.bluetooth.govee/src/main/java/org/openhab/binding/bluetooth/gattserial/MessageHandler.java

@@ -23,14 +23,15 @@ public interface MessageHandler<T extends GattMessage, R extends GattMessage> {
 
     /**
      *
-     * @param payload
+     * @param message
      * @return true if this handler should be removed from the handler list
      */
     boolean handleReceivedMessage(R message);
 
     /**
      *
-     * @param payload
+     * @param message
+     * @param th
      * @return true if this handler should be removed from the handler list
      */
     boolean handleFailedMessage(T message, Throwable th);

bundles/org.openhab.binding.bluetooth.radoneye/src/main/java/org/openhab/binding/bluetooth/radoneye/internal/RadoneyeConfiguration.java

@@ -15,7 +15,7 @@ package org.openhab.binding.bluetooth.radoneye.internal;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * Configuration class for {@link RadoneyeBinding} device.
+ * Configuration class for Radoneye device.
  *
  * @author Peter Obel - Initial contribution
  */

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java

@@ -94,7 +94,7 @@ public abstract class BaseBluetoothDevice extends BluetoothDevice {
      * Construct a Bluetooth device taking the Bluetooth address
      *
      * @param adapter
-     * @param sender
+     * @param address
      */
     public BaseBluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
         super(adapter, address);
@@ -170,7 +170,7 @@ public abstract class BaseBluetoothDevice extends BluetoothDevice {
     /**
      * Sets the device transmit power
      *
-     * @param power the current transmitter power in dBm
+     * @param txPower the current transmitter power in dBm
      */
     public void setTxPower(int txPower) {
         this.txPower = txPower;

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java

@@ -230,9 +230,7 @@ public class BluetoothCharacteristic {
     }
 
     /**
-     * Get the service to which this characteristic belongs
+     * Set the service to which this characteristic belongs
-     *
-     * @return the {@link BluetoothService}
      */
     public void setService(BluetoothService service) {
         this.service = service;

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java

@@ -91,7 +91,7 @@ public abstract class BluetoothDevice {
      * Construct a Bluetooth device taking the Bluetooth address
      *
      * @param adapter
-     * @param sender
+     * @param address
      */
     public BluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
         this.address = address;
@@ -175,7 +175,7 @@ public abstract class BluetoothDevice {
 
     /**
      * Connects to a device. This is an asynchronous method. Once the connection state is updated, the
-     * {@link BluetoothDeviceListener.onConnectionState} method will be called with the connection state.
+     * {@link BluetoothDeviceListener#onConnectionStateChange} method will be called with the connection state.
      * <p>
      * If the device is already connected, this will return false.
      *
@@ -185,7 +185,7 @@ public abstract class BluetoothDevice {
 
     /**
      * Disconnects from a device. Once the connection state is updated, the
-     * {@link BluetoothDeviceListener.onConnectionState}
+     * {@link BluetoothDeviceListener#onConnectionStateChange}
      * method will be called with the connection state.
      * <p>
      * If the device is not currently connected, this will return false.

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java

@@ -76,7 +76,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
     /**
      * Sets the device transmit power
      *
-     * @param power the current transmitter power in dBm
+     * @param txPower the current transmitter power in dBm
      */
     public void setTxPower(int txPower) {
         this.txPower = txPower;
@@ -104,7 +104,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
     /**
      * Set the serial number of the device
      *
-     * @param model a {@link String} defining the serial number
+     * @param serialNumber a {@link String} defining the serial number
      */
     public void setSerialNumberl(String serialNumber) {
         this.serialNumber = serialNumber;
@@ -113,7 +113,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
     /**
      * Set the hardware revision of the device
      *
-     * @param model a {@link String} defining the hardware revision
+     * @param hardwareRevision a {@link String} defining the hardware revision
      */
     public void setHardwareRevision(String hardwareRevision) {
         this.hardwareRevision = hardwareRevision;
@@ -122,7 +122,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
     /**
      * Set the firmware revision of the device
      *
-     * @param model a {@link String} defining the firmware revision
+     * @param firmwareRevision a {@link String} defining the firmware revision
      */
     public void setFirmwareRevision(String firmwareRevision) {
         this.firmwareRevision = firmwareRevision;
@@ -131,7 +131,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
     /**
      * Set the software revision of the device
      *
-     * @param model a {@link String} defining the software revision
+     * @param softwareRevision a {@link String} defining the software revision
      */
     public void setSoftwareRevision(String softwareRevision) {
         this.softwareRevision = softwareRevision;
@@ -207,8 +207,6 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
 
     /**
      * This merges non-null identity fields from the given device into this snapshot.
-     *
-     * @return true if this snapshot changed as a result of this operation
      */
     public void merge(BluetoothDeviceSnapshot device) {
         Integer txPower = device.getTxPower();

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java

@@ -47,7 +47,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * The {@link BluetoothDiscoveryProcess} does the work of creating a DiscoveryResult from a set of
- * {@link BluetoothDisocveryParticipant}s
+ * {@link BluetoothDiscoveryParticipant}s
  *
  * @author Connor Petty - Initial Contribution
  */

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java

@@ -131,7 +131,7 @@ public class BluetoothScanNotification extends BluetoothNotification {
     /**
      * Sets the beacon type for this packet
      *
-     * @beaconType the {@link BluetoothBeaconType} for this packet
+     * @param beaconType the {@link BluetoothBeaconType} for this packet
      */
     public void setBeaconType(BluetoothBeaconType beaconType) {
         this.beaconType = beaconType;

bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BPUPListener.java

@@ -66,7 +66,7 @@ public class BPUPListener implements Runnable {
     /**
      * Constructor of the receiver runnable thread.
      *
-     * @param address The address of the Bond Bridge
+     * @param bridgeHandler The handler of the Bond Bridge
      * @throws SocketException is some problem occurs opening the socket.
      */
     public BPUPListener(BondBridgeHandler bridgeHandler) {

bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BondHttpApi.java

@@ -169,7 +169,7 @@ public class BondHttpApi {
      * Executes a device action
      *
      * @param deviceId The ID of the device
-     * @param actionId The Bond action
+     * @param action The Bond action
      * @param argument An additional argument for the actions (such as the fan speed)
      */
     public synchronized void executeDeviceAction(String deviceId, BondDeviceAction action, @Nullable Integer argument) {

bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/config/BondDeviceConfiguration.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 
 /**
- * The {@link BondHomeConfiguration} class contains fields mapping thing configuration parameters.
+ * The {@link BondDeviceConfiguration} class contains fields mapping thing configuration parameters.
  *
  * @author Sara Geleskie Damiano - Initial contribution
  */

bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/handler/BondBridgeHandler.java

@@ -198,7 +198,7 @@ public class BondBridgeHandler extends BaseBridgeHandler {
     /**
      * Forwards a push update to a device
      *
-     * @param the {@link BPUPUpdate object}
+     * @param pushUpdate the {@link BPUPUpdate object}
      */
     public void forwardUpdateToThing(BPUPUpdate pushUpdate) {
         updateStatus(ThingStatus.ONLINE);

bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/AuthorizationListener.java

@@ -15,8 +15,10 @@ package org.openhab.binding.boschindego.internal;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * {@link} AuthorizationListener} is used for notifying {@link BoschAccountHandler}
+ * {@link AuthorizationListener} is used for notifying
- * when authorization state has changed and for notifying {@link BoschIndegoHandler}
+ * {@link org.openhab.binding.boschindego.internal.handler.BoschAccountHandler}
+ * when authorization state has changed and for notifying
+ * {@link org.openhab.binding.boschindego.internal.handler.BoschIndegoHandler}
  * when authorization flow is completed.
  *
  * @author Jacob Laursen - Initial contribution

bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/BoschIndegoBindingConstants.java

@@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link BoschIndegoBinding} class defines common constants, which are
+ * The {@link BoschIndegoBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Jonas Fleck - Initial contribution

bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java

@@ -261,7 +261,8 @@ public class IndegoController {
     /**
      * Sends a PUT/POST request to the server.
      * 
-     * @param method the type of request ({@link HttpMethod.PUT} or {@link HttpMethod.POST})
+     * @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or
+     *            {@link org.eclipse.jetty.http.HttpMethod.POST})
      * @param path the relative path to which the request should be sent
      * @param requestDto the DTO which should be sent to the server as JSON
      * @throws IndegoAuthenticationException if request was rejected as unauthorized

bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/dto/response/runtime/DeviceStateRuntimes.java

@@ -14,7 +14,8 @@
 package org.openhab.binding.boschindego.internal.dto.response.runtime;
 
 /**
- * Total/session runtime information for {@link DeviceStateResponse}
+ * Total/session runtime information for
+ * {@link org.openhab.binding.boschindego.internal.dto.response.DeviceStateResponse}
  * 
  * @author Jacob Laursen - Initial contribution
  */

bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCHandler.java

@@ -114,7 +114,7 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
 
     /**
      * Initializes this handler. Use this method to register all services of the device with
-     * {@link #registerService(BoschSHCService)}.
+     * {@link #registerService(TService, Consumer<TState>, Collection<String>, boolean)}.
      */
     @Override
     public void initialize() {

bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/bridge/BoschHttpClient.java

@@ -103,7 +103,7 @@ public class BoschHttpClient extends HttpClient {
     }
 
     /**
-     * Returns a SmartHome URL for the endpoint - shortcut of {@link BoschSslUtil::getBoschShcUrl()}
+     * Returns a SmartHome URL for the endpoint - shortcut of {@link #getBoschShcUrl(String)}
      *
      * @param endpoint an endpoint, see https://apidocs.bosch-smarthome.com/local/index.html
      * @return SmartHome URL for passed endpoint

bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/childlock/dto/ChildLockServiceState.java

@@ -16,8 +16,8 @@ import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState;
 import org.openhab.core.library.types.OnOffType;
 
 /**
- * State for {@link ChildLockService} to activate and deactivate the child lock
+ * State for {@link org.openhab.binding.boschshc.internal.services.childlock.ChildLockService}
- * of a device.
+ * to activate and deactivate the child lock of a device.
  * 
  * @author Christian Oeing - Initial contribution
  */

bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/powermeter/dto/PowerMeterServiceState.java

@@ -15,7 +15,7 @@ package org.openhab.binding.boschshc.internal.services.powermeter.dto;
 import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState;
 
 /**
- * State for {@link PowerMeterService}
+ * State for {@link org.openhab.binding.boschshc.internal.services.powermeter.PowerMeterService}
  *
  * @author Stefan Kästle - Initial contribution
  */

bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/BoseSoundTouchBindingConstants.java

@@ -23,7 +23,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link BoseSoundTouchBindinConstantsg} class defines common constants, which are
+ * The {@link BoseSoundTouchBindinConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Christian Niessner - Initial contribution

bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/CommandExecutor.java

@@ -266,7 +266,7 @@ public class CommandExecutor implements AvailableSources {
     /**
      * Post RemoteKey on the device
      *
-     * @param command the command is Type of RemoteKeyType
+     * @param key the key is Type of RemoteKeyType
      */
     public void postRemoteKey(RemoteKeyType key) {
         sendPostRequestInWebSocket("key", "mainNode=\"keyPress\"",

bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/PresetContainer.java

@@ -51,8 +51,6 @@ public class PresetContainer {
 
     /**
      * Returns a Collection of all Presets
-     *
-     * @param operationModeType
      */
     public Collection<ContentItem> getAllPresets() {
         return mapOfPresets.values();

bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/discovery/BroadlinkDiscoveryService.java

@@ -68,7 +68,6 @@ public class BroadlinkDiscoveryService extends AbstractDiscoveryService {
     }
 
     private void createScanner() {
-
         long timestampOfLastScan = getTimestampOfLastScan();
         BLDevice[] blDevices = new BLDevice[0];
         try {

bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/handler/FloureonThermostatHandler.java

@@ -262,7 +262,6 @@ public class FloureonThermostatHandler extends BroadlinkBaseHandler {
     }
 
     protected void refreshData() {
-
         AdvancedStatusInfo advancedStatusInfo = advancedStatusInfoExpiringCache.getValue();
         if (advancedStatusInfo == null) {
             return;

bundles/org.openhab.binding.bsblan/src/main/java/org/openhab/binding/bsblan/internal/helper/BsbLanParameterConverter.java

@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
 import org.unbescape.html.HtmlEscape;
 
 /**
- * The {@link BsbLanParameterHandler} is responsible for updating the data, which are
+ * The {@link BsbLanParameterConverter} is responsible for updating the data, which are
  * sent to one of the channels.
  *
  * @author Peter Schraffl - Initial contribution

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountHandler.java

@@ -82,8 +82,7 @@ public interface SmartherAccountHandler extends ThingHandler {
      *
      * @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     List<Subscription> getSubscriptions() throws SmartherGatewayException;
 
@@ -97,8 +96,7 @@ public interface SmartherAccountHandler extends ThingHandler {
      *
      * @return the identifier this subscription has been registered under
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException;
 
@@ -110,10 +108,7 @@ public interface SmartherAccountHandler extends ThingHandler {
      * @param subscriptionId
      *            the identifier of the subscription to be removed for the given plant
      *
-     * @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *
-     * @throws {@link SmartherGatewayException}
-     *             in case of communication issues with the Smarther API
      */
     void unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException;
 
@@ -138,21 +133,19 @@ public interface SmartherAccountHandler extends ThingHandler {
      *
      * @return the current status of the chronothermostat module
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException;
 
     /**
      * Sends new settings to be applied to a given chronothermostat module.
      *
-     * @param settings
+     * @param moduleSettings
      *            the module settings to be applied
      *
      * @return {@code true} if the settings have been successfully applied, {@code false} otherwise
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     boolean setModuleStatus(ModuleSettings moduleSettings) throws SmartherGatewayException;
 
@@ -166,8 +159,7 @@ public interface SmartherAccountHandler extends ThingHandler {
      *
      * @return the list of registered programs, or an empty {@link List} in case of no programs found
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     List<Program> getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException;
 

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountService.java

@@ -163,8 +163,8 @@ public class SmartherAccountService {
      *
      * @return a string containing the name of the authorized BTicino/Legrand portal user
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API or no account handler
-     *             in case of communication issues with the Smarther API or no account handler found
+     *             found
      */
     public String dispatchAuthorization(String servletBaseURL, String state, String code)
             throws SmartherGatewayException {
@@ -191,8 +191,8 @@ public class SmartherAccountService {
      * @param notification
      *            the received notification to handle
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API or no notification handler
-     *             in case of communication issues with the Smarther API or no notification handler found
+     *             found
      */
     public void dispatchNotification(Notification notification) throws SmartherGatewayException {
         final Sender sender = notification.getSender();

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherNotificationHandler.java

@@ -39,8 +39,7 @@ public interface SmartherNotificationHandler extends ThingHandler {
      * @param plantId
      *            the identifier of the plant the notification endpoint belongs to
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     void registerNotification(String plantId) throws SmartherGatewayException;
 
@@ -58,8 +57,7 @@ public interface SmartherNotificationHandler extends ThingHandler {
      * @param plantId
      *            the identifier of the plant the notification endpoint belongs to
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the Smarther API
-     *             in case of communication issues with the Smarther API
      */
     void unregisterNotification(String plantId) throws SmartherGatewayException;
 }

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApi.java

@@ -125,8 +125,7 @@ public class SmartherApi {
      *
      * @return the list of registered plants, or an empty {@link List} in case of no plants found
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public List<Plant> getPlants() throws SmartherGatewayException {
         try {
@@ -149,8 +148,7 @@ public class SmartherApi {
      *
      * @return the list of registered modules, or an empty {@link List} in case the plant contains no module
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public List<Module> getPlantModules(String plantId) throws SmartherGatewayException {
         try {
@@ -172,8 +170,7 @@ public class SmartherApi {
      *
      * @return the current status of the chronothermostat module
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException {
         try {
@@ -194,8 +191,7 @@ public class SmartherApi {
      *
      * @return {@code true} if the settings have been successfully applied, {@code false} otherwise
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public boolean setModuleStatus(ModuleSettings settings) throws SmartherGatewayException {
         // Prepare request payload
@@ -252,8 +248,7 @@ public class SmartherApi {
      *
      * @return the list of registered programs, or an empty {@link List} in case of no programs found
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public List<Program> getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException {
         try {
@@ -274,8 +269,7 @@ public class SmartherApi {
      *
      * @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public List<Subscription> getSubscriptions() throws SmartherGatewayException {
         try {
@@ -306,8 +300,7 @@ public class SmartherApi {
      *
      * @return the identifier this subscription has been registered under
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException {
         try {
@@ -336,8 +329,7 @@ public class SmartherApi {
      *
      * @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException in case of communication issues with the API gateway
-     *             in case of communication issues with the API gateway
      */
     public boolean unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException {
         final ContentResponse response = requestBasic(DELETE, String.format(PATH_UNSUBSCRIBE, plantId, subscriptionId));

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApiConnector.java

@@ -113,8 +113,7 @@ public class SmartherApiConnector {
      *
      * @return the raw response returned by the API gateway
      *
-     * @throws {@link SmartherGatewayException}
+     * @throws SmartherGatewayException if the call failed due to an issue with the API gateway
-     *             if the call failed due to an issue with the API gateway
      */
     public ContentResponse request(Function<HttpClient, Request> requester, String subscription, String authorization)
             throws SmartherGatewayException {

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Chronothermostat.java

@@ -104,8 +104,8 @@ public class Chronothermostat {
      *
      * @return a {@link MeasureUnit} object representing the module operational temperature format
      *
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
-     *             if the measure internal raw unit cannot be mapped to any valid measure unit
+     *             measure unit
      */
     public MeasureUnit getTemperatureFormatUnit() throws SmartherIllegalPropertyValueException {
         return MeasureUnit.fromValue(temperatureFormat);
@@ -125,8 +125,8 @@ public class Chronothermostat {
      *
      * @return {@code true} if the load state is active, {@code false} otherwise
      *
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException if the load state internal raw value cannot be mapped to any valid
-     *             if the load state internal raw value cannot be mapped to any valid load state enum value
+     *             load state enum value
      */
     public boolean isActive() throws SmartherIllegalPropertyValueException {
         return LoadState.fromValue(loadState).isActive();

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Enums.java

@@ -54,8 +54,7 @@ public class Enums {
          *
          * @return the enum value representing the given raw value
          *
-         * @throws {@link SmartherIllegalPropertyValueException}
+         * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
-         *             if the raw value cannot be mapped to any valid enum value
          */
         public static Function fromValue(String value) throws SmartherIllegalPropertyValueException {
             return lookup(Function.class, value);
@@ -91,8 +90,7 @@ public class Enums {
          *
          * @return the enum value representing the given raw value
          *
-         * @throws {@link SmartherIllegalPropertyValueException}
+         * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
-         *             if the raw value cannot be mapped to any valid enum value
          */
         public static Mode fromValue(String value) throws SmartherIllegalPropertyValueException {
             return lookup(Mode.class, value);
@@ -134,8 +132,7 @@ public class Enums {
          *
          * @return the enum value representing the given raw value
          *
-         * @throws {@link SmartherIllegalPropertyValueException}
+         * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
-         *             if the raw value cannot be mapped to any valid enum value
          */
         public static LoadState fromValue(String value) throws SmartherIllegalPropertyValueException {
             return lookup(LoadState.class, value);
@@ -190,8 +187,7 @@ public class Enums {
          *
          * @return the enum value representing the given raw value
          *
-         * @throws {@link SmartherIllegalPropertyValueException}
+         * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
-         *             if the raw value cannot be mapped to any valid enum value
          */
         public static MeasureUnit fromValue(String value) throws SmartherIllegalPropertyValueException {
             return lookup(MeasureUnit.class, value);
@@ -225,8 +221,7 @@ public class Enums {
          *
          * @return the enum value representing the given raw value
          *
-         * @throws {@link SmartherIllegalPropertyValueException}
+         * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
-         *             if the raw value cannot be mapped to any valid enum value
          */
         public static BoostTime fromValue(int value) throws SmartherIllegalPropertyValueException {
             return lookup(BoostTime.class, value);

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Measure.java

@@ -69,8 +69,8 @@ public class Measure {
      *
      * @return a {@link MeasureUnit} object representing the measure unit
      *
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
-     *             if the measure internal raw unit cannot be mapped to any valid measure unit
+     *             measure unit
      */
     public MeasureUnit getMeasureUnit() throws SmartherIllegalPropertyValueException {
         return MeasureUnit.fromValue(unit);
@@ -81,8 +81,8 @@ public class Measure {
      *
      * @return the value and measure unit
      *
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
-     *             if the measure internal raw unit cannot be mapped to any valid measure unit
+     *             measure unit
      */
     public State toState() throws SmartherIllegalPropertyValueException {
         State state = UnDefType.UNDEF;

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Sensor.java

@@ -54,8 +54,8 @@ public class Sensor {
      *
      * @return a {@link State} object representing the overall state of the sensor
      *
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException if the sensor internal raw state cannot be mapped to any valid
-     *             if the sensor internal raw state cannot be mapped to any valid value
+     *             value
      */
     public State toState() throws SmartherIllegalPropertyValueException {
         final Measure measure = getMeasure(0);

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/exception/SmartherNotificationException.java

@@ -39,7 +39,7 @@ public class SmartherNotificationException extends RuntimeException {
      *
      * @param message
      *            the error message returned from the API gateway
-     * @param cause
+     * @param exception
      *            the cause (a null value is permitted, and indicates that the cause is nonexistent or unknown)
      */
     public SmartherNotificationException(String message, Throwable exception) {

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/DateUtil.java

@@ -42,8 +42,7 @@ public final class DateUtil {
      *
      * @return a {@link LocalDate} object containing the parsed date
      *
-     * @throws {@link DateTimeParseException}
+     * @throws DateTimeParseException if the string cannot be parsed to a local date
-     *             if the string cannot be parsed to a local date
      */
     public static LocalDate parseDate(@Nullable String str, String pattern) {
         if (str == null) {
@@ -63,8 +62,7 @@ public final class DateUtil {
      *
      * @return a {@link LocalDateTime} object containing the parsed date and time
      *
-     * @throws {@link DateTimeParseException}
+     * @throws DateTimeParseException if the string cannot be parsed to a local date and time
-     *             if the string cannot be parsed to a local date and time
      */
     public static LocalDateTime parseLocalTime(@Nullable String str, String pattern) {
         if (str == null) {
@@ -84,8 +82,7 @@ public final class DateUtil {
      *
      * @return a {@link ZonedDateTime} object containing the parsed date and time with timezone
      *
-     * @throws {@link DateTimeParseException}
+     * @throws DateTimeParseException if the string cannot be parsed to a date and time with timezone
-     *             if the string cannot be parsed to a date and time with timezone
      */
     public static ZonedDateTime parseZonedTime(@Nullable String str, String pattern) {
         if (str == null) {
@@ -119,8 +116,7 @@ public final class DateUtil {
      *
      * @return a string representing the local date and time object
      *
-     * @throws {@link DateTimeException}
+     * @throws DateTimeException if an error occurs during printing
-     *             if an error occurs during printing
      */
     public static String format(LocalDateTime date, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -137,8 +133,7 @@ public final class DateUtil {
      *
      * @return a string representing the date and time with timezone object
      *
-     * @throws {@link DateTimeException}
+     * @throws DateTimeException if an error occurs during printing
-     *             if an error occurs during printing
      */
     public static String format(ZonedDateTime date, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -158,8 +153,7 @@ public final class DateUtil {
      *
      * @return a string representing the range between the two local date and time objects
      *
-     * @throws {@link DateTimeException}
+     * @throws DateTimeException if an error occurs during printing
-     *             if an error occurs during printing
      */
     public static String formatRange(LocalDateTime date1, LocalDateTime date2, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -180,8 +174,7 @@ public final class DateUtil {
      *
      * @return a string representing the range between the two date and time with timezone objects
      *
-     * @throws {@link DateTimeException}
+     * @throws DateTimeException if an error occurs during printing
-     *             if an error occurs during printing
      */
     public static String formatRange(ZonedDateTime date1, ZonedDateTime date2, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/StringUtil.java

@@ -136,8 +136,7 @@ public final class StringUtil {
      *
      * @return the string read from stream
      *
-     * @throws {@link IOException}
+     * @throws IOException if an I/O error occurs
-     *             if an I/O error occurs
      */
     public static String streamToString(InputStream input) throws IOException {
         InputStreamReader reader = new InputStreamReader(input);
@@ -162,8 +161,7 @@ public final class StringUtil {
      *
      * @return the string read from stream
      *
-     * @throws {@link IOException}
+     * @throws IOException if an I/O error occurs
-     *             if an I/O error occurs
      */
     public static String readerToString(Reader reader) throws IOException {
         final StringWriter writer = new StringWriter();

bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/CaddxCommunicator.java

@@ -316,7 +316,7 @@ public class CaddxCommunicator implements SerialPortEventListener {
     /**
      * Event handler to receive the data from the serial port
      *
-     * @param SerialPortEvent serialPortEvent The event that occurred on the serial port
+     * @param serialPortEvent The event that occurred on the serial port
      */
     @Override
     public void serialEvent(@Nullable SerialPortEvent serialPortEvent) {

bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/handler/CaddxBaseThingHandler.java

@@ -102,15 +102,14 @@ public abstract class CaddxBaseThingHandler extends BaseThingHandler {
      * Method to Update a Channel
      *
      * @param channel
-     * @param state
+     * @param data
-     * @param description
      */
     public abstract void updateChannel(ChannelUID channel, String data);
 
     /**
      * Receives Events from the bridge.
      *
-     * @param event.
+     * @param event
      * @param thing
      */
     public abstract void caddxEventReceived(CaddxEvent event, Thing thing);

bundles/org.openhab.binding.cbus/src/main/java/org/openhab/binding/cbus/CBusBindingConstants.java

@@ -20,7 +20,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link CBusBinding} class defines common constants, which are
+ * The {@link CBusBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Scott Linton - Initial contribution

bundles/org.openhab.binding.cm11a/src/main/java/org/openhab/binding/cm11a/internal/CM11ABindingConstants.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
- * The {@link CM11ABinding} class defines common constants, which are
+ * The {@link CM11ABindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Bob Raker - Initial contribution

bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirCommandType.java

@@ -780,7 +780,7 @@ public enum ComfoAirCommandType {
      *
      * @param key
      *            command key
-     * @param value
+     * @param command
      *            new state
      * @return initialized ComfoAirCommand
      */

bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialConnector.java

@@ -68,7 +68,7 @@ public class ComfoAirSerialConnector {
     /**
      * Open serial port.
      *
-     * @throws PortInUseException, UnsupportedCommOperationException, IOException
+     * @throws ComfoAirSerialException
      */
     public void open() throws ComfoAirSerialException {
         logger.debug("open(): Opening ComfoAir connection");

bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialException.java

@@ -15,7 +15,7 @@ package org.openhab.binding.comfoair.internal;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * The {@link ConnectException} is thrown on errors relating the serial connection.
+ * The {@link ComfoAirSerialException} is thrown on errors relating the serial connection.
  *
  * @author Hans Böhm - Initial contribution
  */

bundles/org.openhab.binding.coolmasternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java

@@ -186,7 +186,7 @@ public final class ControllerHandler extends BaseBridgeHandler {
      * This method automatically acquires a connection.
      *
      * @return the server response to the command (never empty)
-     * @throws {@link IOException} if communications failed with the server
+     * @throws IOException if communications failed with the server
      */
     public String sendCommand(final String command) throws IOException {
         synchronized (socketLock) {

bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsCountryConfiguration.java

@@ -15,7 +15,8 @@ package org.openhab.binding.coronastats.internal.config;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * Configuration for the {@link CoronaStatsCountryHandler}
+ * Configuration for the
+ * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsCountryHandler}
  *
  * @author Johannes Ott - Initial contribution
  */

bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsWorldConfiguration.java

@@ -15,7 +15,8 @@ package org.openhab.binding.coronastats.internal.config;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * Configuration for the {@link CoronaStatsWorldHandler}
+ * Configuration for the
+ * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsWorldHandler}
  *
  * @author Johannes Ott - Initial contribution
  */

bundles/org.openhab.binding.dali/src/main/java/org/openhab/binding/dali/internal/handler/DaliDt8DeviceHandler.java

@@ -124,7 +124,6 @@ public class DaliDt8DeviceHandler extends DaliDeviceHandler {
                     logger.warn("Error querying device status: {}", e.getMessage());
                     return null;
                 });
-
             } else if (CHANNEL_COLOR.equals(channelUID.getId())) {
                 DaliAddress address;
                 if (THING_TYPE_DEVICE_DT8.equals(this.thing.getThingTypeUID())) {
@@ -189,7 +188,6 @@ public class DaliDt8DeviceHandler extends DaliDeviceHandler {
                     logger.warn("Error querying device status: {}", e.getMessage());
                     return null;
                 });
-
             } else {
                 super.handleCommand(channelUID, command);
             }

bundles/org.openhab.binding.dbquery/src/main/java/org/openhab/binding/dbquery/internal/dbimpl/influx2/Influx2Database.java

@@ -82,7 +82,6 @@ public class Influx2Database implements Database {
     public CompletableFuture<QueryResult> executeQuery(Query query) {
         try {
             if (query instanceof Influx2QueryFactory.Influx2Query influxQuery) {
-
                 CompletableFuture<QueryResult> asyncResult = new CompletableFuture<>();
                 List<FluxRecord> records = new ArrayList<>();
                 client.query(influxQuery.getQuery(), (cancellable, record) -> { // onNext

bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/DenonMarantzBindingConstants.java

@@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID;
 import org.openhab.core.thing.type.ChannelTypeUID;
 
 /**
- * The {@link DenonMarantzBinding} class defines common constants, which are
+ * The {@link DenonMarantzBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Jan-Willem Veldhuis - Initial contribution

bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/TripLabelAttribute.java

@@ -31,7 +31,7 @@ import org.openhab.core.types.UnDefType;
  * 
  * chapter "1.2.7 TripLabel" in Technical Interface Description for external Developers
  *
- * @see @see <a href="https://developers.deutschebahn.com/db-api-marketplace/apis/product/timetables">DB API
+ * @see See <a href="https://developers.deutschebahn.com/db-api-marketplace/apis/product/timetables">DB API
  *      Marketplace</a>
  * 
  * @author Sönke Küper - Initial contribution.

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java

@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * The {@link BridgeMDNSDiscoveryParticipant} is responsible for discovering digitalSTROM-Server. It uses the central
- * {@link MDNSDiscoveryService}.
+ * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java

@@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory;
  * The {@link DeviceDiscoveryService} discovers all digitalSTROM-Devices, of one supported device-color-type. The
  * device-color-type has to be given to the {@link #DeviceDiscoveryService(BridgeHandler, ThingTypeUID)} as
  * {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at
- * {@link DeviceHandler#SUPPORTED_THING_TYPES}.
+ * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler#SUPPORTED_THING_TYPES}.
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution
@@ -170,7 +170,8 @@ public class DeviceDiscoveryService extends AbstractDiscoveryService {
     }
 
     /**
-     * Removes the {@link Thing} of the given {@link Device}.
+     * Removes the {@link org.openhab.core.thing.Thing} of the given
+     * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}.
      *
      * @param device (must not be null)
      */
@@ -184,7 +185,8 @@ public class DeviceDiscoveryService extends AbstractDiscoveryService {
 
     /**
      * Creates a {@link DiscoveryResult} for the given {@link Device}, if the {@link Device} is supported and the
-     * {@link Device#getOutputMode()} is unequal {@link OutputModeEnum#DISABLED}.
+     * {@link Device#getOutputMode()} is unequal
+     * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#DISABLED}.
      *
      * @param device (must not be null)
      */

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java

@@ -60,8 +60,9 @@ public class DiscoveryServiceManager
 
     /**
      * Creates a new {@link DiscoveryServiceManager} and generates automatically all {@link SceneDiscoveryService}s and
-     * {@link DeviceDiscoveryService}s for all supported {@link ThingType}s of the {@link DeviceHandler} and
+     * {@link org.openhab.binding.digitalstrom.internal.discovery.DeviceDiscoveryService}s for all supported
-     * {@link SceneHandler}.
+     * {@link org.openhab.core.thing.type.ThingType}s of the
+     * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler} and {@link SceneHandler}.
      *
      * @param bridgeHandler (must not be null)
      */

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java

@@ -38,7 +38,8 @@ import org.slf4j.LoggerFactory;
 /**
  * The {@link SceneDiscoveryService} discovers all digitalSTROM-scene of one supported scene-type. The scene-type has to
  * be given to the {@link #SceneDiscoveryService(BridgeHandler, ThingTypeUID)} as
- * {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at {@link SceneHandler#SUPPORTED_THING_TYPES}
+ * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
+ * can be found at {@link org.openhab.binding.digitalstrom.internal.handler.SceneHandler#SUPPORTED_THING_TYPES}
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java

@@ -34,8 +34,10 @@ import org.slf4j.LoggerFactory;
 /**
  * The {@link ZoneTemperatureControlDiscoveryService} discovers all digitalSTROM zones which have temperature control
  * configured. The thing-type has to be given to the
- * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as {@link ThingTypeUID}. The supported
+ * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as
- * {@link ThingTypeUID} can be found at {@link ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
+ * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
+ * can be found at
+ * {@link org.openhab.binding.digitalstrom.internal.handler.ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java

@@ -24,7 +24,8 @@ import com.google.gson.JsonObject;
 
 /**
  * The {@link SensorValues} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. So the
- * {@link SensorValues} contains all {@link CachedSensorValue}s of a zone.
+ * {@link SensorValues} contains all
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s of a zone.
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java

@@ -119,7 +119,9 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the refenceZone, if control-mode is {@link ControlModes#ZONE_FOLLOWER}, otherwise null.
+     * Returns the refenceZone, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#ZONE_FOLLOWER}, otherwise
+     * null.
      *
      * @return the referenceZone
      */
@@ -128,7 +130,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlOffset, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlOffset, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlOffset
      */
@@ -137,7 +140,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the manualValue, if control-mode is {@link ControlModes#MANUAL}, otherwise null.
+     * Returns the manualValue, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#MANUAL}, otherwise null.
      *
      * @return the manualValue
      */
@@ -146,7 +150,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the emergencyValue, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the emergencyValue, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the emergencyValue
      */
@@ -155,7 +160,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlKp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlKp, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlKp
      */
@@ -164,7 +170,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlTs, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlTs, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlTs
      */
@@ -173,7 +180,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlTi, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlTi, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlTi
      */
@@ -182,7 +190,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlKd, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlKd, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlKd
      */
@@ -191,7 +200,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlImin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlImin, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlImin
      */
@@ -200,7 +210,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlImax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlImax, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlImax
      */
@@ -209,7 +220,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlYmin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlYmin, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlYmin
      */
@@ -218,7 +230,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlYmax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlYmax, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlYmax
      */
@@ -227,7 +240,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlAntiWindUp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlAntiWindUp, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlAntiWindUp
      */
@@ -236,7 +250,8 @@ public class TemperatureControlConfig extends BaseTemperatureControl {
     }
 
     /**
-     * Returns the ctrlKeepFloorWarm, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+     * Returns the ctrlKeepFloorWarm, if control-mode is
+     * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
      *
      * @return the ctrlKeepFloorWarm
      */

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java

@@ -80,7 +80,7 @@ public class TemperatureControlValues extends BaseZoneIdentifier {
     }
 
     /**
-     * @see TemperatureControlStatus#getControlDSUID()
+     * @see org.openhab.binding.digitalstrom.internal.lib.climate.jsonresponsecontainer.impl.TemperatureControlStatus#getControlDSUID()
      * @return the controlDSUID
      */
     public String getControlDSUID() {
@@ -88,7 +88,7 @@ public class TemperatureControlValues extends BaseZoneIdentifier {
     }
 
     /**
-     * @see TemperatureControlStatus#getIsConfigured()
+     * @see org.openhab.binding.digitalstrom.internal.lib.serverconnection.constants.JSONApiResponseKeysEnum#IS_CONFIGURED
      * @return the isConfigured
      */
     public Boolean getIsConfigured() {

bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java

@@ -26,8 +26,9 @@ import com.google.gson.JsonObject;
 
 /**
  * The {@link WeatherSensorData} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. The
- * {@link WeatherSensorData} contains all {@link CachedSensorValue}s and weather service information of the
+ * {@link WeatherSensorData} contains all
- * digitalSTROM-server, if a weather service is set.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s and weather service
+ * information of the digitalSTROM-server, if a weather service is set.
  *
  * @author Michael Ochel - Initial contribution
  * @author Matthias Siegele - Initial contribution