Improve javadoc for all addons (#15667)

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

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/RussoundBindingConstants.java

@@ -15,7 +15,7 @@ package org.openhab.binding.russound.internal;
 import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
- * The {@link RussoundBinding} class defines common constants, which are
+ * The {@link RussoundBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
  * @author Tim Roberts - Initial contribution

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractBridgeHandler.java

@@ -186,7 +186,7 @@ public abstract class AbstractBridgeHandler<E extends AbstractRioProtocol> exten
     }
 
     /**
-     * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the
+     * Overrides the base method to remove any state linked to the {@link ChannelUID} from the
      * {@link StatefulHandlerCallback}
      */
     @Override

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractRioProtocol.java

@@ -117,8 +117,8 @@ public abstract class AbstractRioProtocol implements SocketSessionListener {
     }
 
     /**
-     * Implements the {@link SocketSessionListener#responseException(Exception)} to automatically take the thing offline
-     * via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)}
+     * Implements the {@link SocketSessionListener#responseException(IOException)} to automatically take the thing
+     * offline via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)}
      *
      * @param e the exception
      */

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractThingHandler.java

@@ -109,7 +109,7 @@ public abstract class AbstractThingHandler<E extends AbstractRioProtocol> extend
     }
 
     /**
-     * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the
+     * Overrides the base method to remove any state linked to the {@link ChannelUID} from the
      * {@link StatefulHandlerCallback}
      */
     @Override

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioHandlerCallback.java

@@ -38,7 +38,7 @@ public interface RioHandlerCallback {
      * Callback to the bridge/thing to update the state of a channel in the bridge/thing.
      *
      * @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);
 

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java

@@ -436,7 +436,7 @@ public class RioPresetsProtocol extends AbstractRioProtocol {
      * Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the
      * russound system. This response may be for other protocol handler - so ignore if we don't recognize the response.
      *
-     * @param a possibly null, possibly empty response
+     * @param response a possibly null, possibly empty response
      */
     @Override
     public void responseReceived(@Nullable String response) {

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java

@@ -309,7 +309,7 @@ public class RioSystemFavoritesProtocol extends AbstractRioProtocol {
      * Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the
      * russound system. This response may be for other protocol handler - so ignore if we don't recognize the response.
      *
-     * @param a possibly null, possibly empty response
+     * @param response a possibly null, possibly empty response
      */
     @Override
     public void responseReceived(@Nullable String response) {

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/controller/RioControllerHandler.java

@@ -125,7 +125,7 @@ public class RioControllerHandler extends AbstractBridgeHandler<RioControllerPro
     /**
      * Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a
      * {@link RioSystemHandler}. Once validated, a {@link RioControllerProtocol} is set via
-     * {@link #setProtocolHandler(RioControllerProtocol)} and the bridge comes online.
+     * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online.
      */
     @Override
     public void initialize() {
@@ -205,7 +205,7 @@ public class RioControllerHandler extends AbstractBridgeHandler<RioControllerPro
     }
 
     /**
-     * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names
+     * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names
      */
     @Override
     public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) {
@@ -213,7 +213,7 @@ public class RioControllerHandler extends AbstractBridgeHandler<RioControllerPro
     }
 
     /**
-     * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names
+     * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names
      */
     @Override
     public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) {

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java

@@ -55,7 +55,7 @@ public class RioPreset {
      * "Preset " + id
      *
      * @param id a preset ID between 1 and 36
-     * @param isValid true if the preset is valid, false otherwise
+     * @param valid true if the preset is valid, false otherwise
      * @param name a possibly null, possibly empty preset name
      * @throws IllegalArgumentException if id < 1 or > 32
      */

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java

@@ -462,7 +462,7 @@ public class RioSystemHandler extends AbstractBridgeHandler<RioSystemProtocol> {
     }
 
     /**
-     * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names
+     * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names
      */
     @Override
     public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) {
@@ -470,7 +470,7 @@ public class RioSystemHandler extends AbstractBridgeHandler<RioSystemProtocol> {
     }
 
     /**
-     * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names
+     * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names
      */
     @Override
     public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) {

bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/zone/RioZoneHandler.java

@@ -398,7 +398,7 @@ public class RioZoneHandler extends AbstractThingHandler<RioZoneProtocol>
     /**
      * Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a
      * {@link RioControllerHandler}. Once validated, a {@link RioZoneProtocol} is set via
-     * {@link #setProtocolHandler(RioZoneProtocol)} and the bridge comes online.
+     * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online.
      */
     @Override
     public void initialize() {