Improve javadoc for all addons (#15667)

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

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoControlHandlerFactory.java

@@ -43,7 +43,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The {@link TapoControlHandler} is responsible for handling commands, which are
+ * The {@link ThingHandler} is responsible for handling commands, which are
  * sent to one of the channels.
  *
  * @author Christian Wild - Initial contribution

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoDiscoveryService.java

@@ -56,8 +56,6 @@ public class TapoDiscoveryService extends AbstractDiscoveryService implements Th
 
     /**
      * INIT CLASS
-     * 
-     * @param bridgeHandler
      */
     public TapoDiscoveryService() {
         super(SUPPORTED_THING_TYPES_UIDS, TAPO_DISCOVERY_TIMEOUT_S, false);

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java

@@ -58,7 +58,8 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi {
     /**
      * INIT CLASS
      *
-     * @param config TapoControlConfiguration class
+     * @param device
+     * @param bridgeThingHandler
      */
     public TapoDeviceConnector(TapoDevice device, TapoBridgeHandler bridgeThingHandler) {
         super(device, bridgeThingHandler);
@@ -111,7 +112,7 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi {
     /**
      * send custom command to device
      *
-     * @param plBuilder Payloadbuilder with unencrypted payload
+     * @param queryMethod query method
      */
     public void sendCustomQuery(String queryMethod) {
         /* create payload */
@@ -390,7 +391,7 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi {
     /**
      * handle error
      *
-     * @param te TapoErrorHandler
+     * @param tapoError TapoErrorHandler
      */
     @Override
     protected void handleError(TapoErrorHandler tapoError) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceHttpApi.java

@@ -66,7 +66,8 @@ public class TapoDeviceHttpApi {
     /**
      * INIT CLASS
      *
-     * @param config TapoControlConfiguration class
+     * @param device
+     * @param bridgeThingHandler
      */
     public TapoDeviceHttpApi(TapoDevice device, TapoBridgeHandler bridgeThingHandler) {
         this.bridge = bridgeThingHandler;
@@ -125,7 +126,7 @@ public class TapoDeviceHttpApi {
     /**
      * handle error
      *
-     * @param te TapoErrorHandler
+     * @param tapoError TapoErrorHandler
      */
     protected void handleError(TapoErrorHandler tapoError) {
     }
@@ -563,7 +564,7 @@ public class TapoDeviceHttpApi {
     /**
      * Set new ipAddress
      *
-     * @param new ipAdress
+     * @param ipAddress new ipAdress
      */
     public void setDeviceURL(String ipAddress) {
         this.ipAddress = ipAddress;
@@ -584,7 +585,6 @@ public class TapoDeviceHttpApi {
     /**
      * Set new token
      *
-     * @param deviceURL
      * @param token
      */
     protected void setToken(String token) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java

@@ -376,7 +376,7 @@ public abstract class TapoDevice extends BaseThingHandler {
     /**
      * Set Device Child data to device
      *
-     * @param energyData
+     * @param hostData
      */
     public void setChildData(TapoChildData hostData) {
         hostData.getChildDeviceList().forEach(child -> {
@@ -399,7 +399,7 @@ public abstract class TapoDevice extends BaseThingHandler {
      * If only one property must be changed, there is also a convenient method
      * updateProperty(String name, String value).
      *
-     * @param TapoDeviceInfo
+     * @param deviceInfo
      */
     protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
         /* device properties */

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoLightStrip.java

@@ -200,7 +200,7 @@ public class TapoLightStrip extends TapoDevice {
     /**
      * UPDATE PROPERTIES
      * 
-     * @param TapoDeviceInfo
+     * @param deviceInfo TapoDeviceInfo
      */
     @Override
     protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartBulb.java

@@ -171,7 +171,7 @@ public class TapoSmartBulb extends TapoDevice {
     /**
      * UPDATE PROPERTIES
      * 
-     * @param TapoDeviceInfo
+     * @param deviceInfo TapoDeviceInfo
      */
     @Override
     protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartPlug.java

@@ -81,7 +81,7 @@ public class TapoSmartPlug extends TapoDevice {
     /**
      * UPDATE PROPERTIES
      *
-     * @param TapoDeviceInfo
+     * @param deviceInfo TapoDeviceInfo
      */
     @Override
     protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoUniversalDevice.java

@@ -182,7 +182,7 @@ public class TapoUniversalDevice extends TapoDevice {
     /**
      * UPDATE PROPERTIES
      * 
-     * @param TapoDeviceInfo
+     * @param deviceInfo TapoDeviceInfo
      */
     @Override
     protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCipher.java

@@ -58,7 +58,6 @@ public class TapoCipher {
      * 
      * @param handshakeKey Key from Handshake-Request
      * @param credentials TapoCredentials
-     * @throws Exception
      */
     public TapoCipher(String handshakeKey, TapoCredentials credentials) {
         setKey(handshakeKey, credentials);

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCredentials.java

@@ -52,8 +52,8 @@ public class TapoCredentials {
     /**
      * INIT CLASS
      *
-     * @param email E-Mail-adress of Tapo Cloud
-     * @param passowrd Password of Tapo Cloud
+     * @param eMail E-Mail-adress of Tapo Cloud
+     * @param password Password of Tapo Cloud
      */
     public TapoCredentials(String eMail, String password) {
         this.mimeEncoder = new MimeEncode();
@@ -63,8 +63,8 @@ public class TapoCredentials {
     /**
      * set credentials.
      *
-     * @param username username (eMail-adress) of Tapo Cloud
-     * @param passowrd Password of Tapo Cloud
+     * @param eMail username (eMail-adress) of Tapo Cloud
+     * @param password Password of Tapo Cloud
      */
     public void setCredectials(String eMail, String password) {
         try {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoErrorHandler.java

@@ -62,7 +62,7 @@ public class TapoErrorHandler extends Exception {
     /**
      * Constructor
      * 
-     * @param exception Exception
+     * @param ex Exception
      */
     public TapoErrorHandler(Exception ex) {
         raiseError(ex);
@@ -71,7 +71,7 @@ public class TapoErrorHandler extends Exception {
     /**
      * Constructor
      * 
-     * @param exception Exception
+     * @param ex Exception
      * @param infoMessage optional info-message
      */
     public TapoErrorHandler(Exception ex, String infoMessage) {
@@ -142,7 +142,7 @@ public class TapoErrorHandler extends Exception {
     /**
      * Raises new error
      * 
-     * @param exception Exception
+     * @param ex Exception
      */
     public void raiseError(Exception ex) {
         raiseError(ex, "");
@@ -151,7 +151,7 @@ public class TapoErrorHandler extends Exception {
     /**
      * Raises new error
      * 
-     * @param exception Exception
+     * @param ex Exception
      * @param infoMessage optional info-message
      */
     public void raiseError(Exception ex, String infoMessage) {

bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java

@@ -269,7 +269,7 @@ public class TapoUtils {
     /**
      * Return OnOffType from bool
      * 
-     * @param boolVal
+     * @param intVal
      */
     public static OnOffType getOnOffType(Integer intVal) {
         return intVal == 0 ? OnOffType.OFF : OnOffType.ON;