Improve javadoc for some addons (#15701)

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

bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/watch/JRubyScriptFileWatcher.java

@@ -34,7 +34,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Monitors <openHAB-conf>/automation/ruby for Ruby files, but not libraries in lib or gems
+ * Monitors {@code <openHAB-conf>/automation/ruby} for Ruby files, but not libraries in lib or gems
  *
  * @author Cody Cutrer - Initial contribution
  * @author Jan N. Klug - Refactored to new WatchService

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java

@@ -66,7 +66,7 @@ import com.oracle.truffle.js.scriptengine.GraalJSScriptEngine;
  * @author Dan Cunningham - Script injections
  * @author Florian Hotze - Create lock object for multi-thread synchronization; Inject the {@link JSRuntimeFeatures}
  *         into the JS context; Fix memory leak caused by HostObject by making HostAccess reference static; Switch to
- *         {@link Lock} for multi-thread synchronization; globals & openhab-js injection code caching
+ *         {@link Lock} for multi-thread synchronization; globals and openhab-js injection code caching
  */
 public class OpenhabGraalJSScriptEngine
         extends InvocationInterceptingScriptEngineWithInvocableAndAutoCloseable<GraalJSScriptEngine> {
@@ -142,8 +142,8 @@ public class OpenhabGraalJSScriptEngine
     private final boolean injectionCachingEnabled;
 
     /**
-     * Creates an implementation of ScriptEngine (& Invocable), wrapping the contained engine, that tracks the script
+     * Creates an implementation of ScriptEngine {@code (& Invocable)}, wrapping the contained engine,
-     * lifecycle and provides hooks for scripts to do so too.
+     * that tracks the script lifecycle and provides hooks for scripts to do so too.
      */
     public OpenhabGraalJSScriptEngine(boolean injectionEnabled, boolean injectionCachingEnabled,
             JSScriptServiceUtil jsScriptServiceUtil, JSDependencyTracker jsDependencyTracker) {

bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/fs/watch/JSScriptFileWatcher.java

@@ -29,7 +29,7 @@ import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
 /**
- * Monitors <openHAB-conf>/automation/js for Javascript files, but not libraries
+ * Monitors {@code <openHAB-conf>/automation/js} for Javascript files, but not libraries
  *
  * @author Jonathan Gilbert - Initial contribution
  * @author Jan N. Klug - Refactored to new WatchService

bundles/org.openhab.binding.ahawastecollection/src/main/java/org/openhab/binding/ahawastecollection/internal/AhaCollectionSchedule.java

@@ -28,6 +28,8 @@ public interface AhaCollectionSchedule {
 
     /**
      * Returns the next collection dates per {@link WasteType}.
+     *
+     * @throws IOException
      */
     Map<WasteType, CollectionDate> getCollectionDates() throws IOException;
 }

bundles/org.openhab.binding.airvisualnode/src/main/java/org/openhab/binding/airvisualnode/internal/discovery/AirVisualNodeDiscoveryService.java

@@ -37,7 +37,8 @@ import jcifs.netbios.NbtAddress;
 import jcifs.smb.SmbFile;
 
 /**
- * Autodiscovery for AirVisual Node by searching for a host advertised with the NetBIOS name 'AVISUAL-<SerialNumber>'.
+ * Autodiscovery for AirVisual Node by searching for a host advertised with the NetBIOS name
+ * {@code 'AVISUAL-<SerialNumber>'}.
  *
  * @author Victor Antonovich - Initial contribution
  */

bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/handler/ZoneHandler.java

@@ -29,7 +29,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The {@link ZoneHandler} is responsible for handling wired zones (i.e. REL & EXP messages).
+ * The {@link ZoneHandler} is responsible for handling wired zones (i.e. REL & EXP messages).
  *
  * @author Bob Adair - Initial contribution
  * @author Bill Forsyth - Initial contribution

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

@@ -66,8 +66,8 @@ public final class ADCommand {
 
     /**
      * Construct an AD configuration command. If configParam is null, a query configuration command will be created.
-     * If configParam consists of one or more NAME=value pairs (separated by '&' characters), a set configuration
+     * If configParam consists of one or more NAME=value pairs (separated by {@code '&'} characters), a set
-     * command will be created. The validity of configParam is not checked.
+     * configuration command will be created. The validity of configParam is not checked.
      *
      * @param configParam String containing parameters to set or null
      * @return ADCommand object containing the constructed command

bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/MoonCalc.java

@@ -35,9 +35,9 @@ import org.openhab.binding.astro.internal.util.DateTimeUtils;
  *
  * @author Gerhard Riegler - Initial contribution
  * @author Christoph Weitkamp - Introduced UoM
- * @see based on the calculations of
+ * @implNote based on the calculations of
- *      http://www.computus.de/mondphase/mondphase.htm azimuth/elevation and
+ *           http://www.computus.de/mondphase/mondphase.htm azimuth/elevation and
- *      zodiac based on http://lexikon.astronomie.info/java/sunmoon/
+ *           zodiac based on http://lexikon.astronomie.info/java/sunmoon/
  */
 public class MoonCalc {
     private static final double NEW_MOON = 0;

bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SeasonCalc.java

@@ -22,7 +22,7 @@ import org.openhab.binding.astro.internal.util.DateTimeUtils;
  * Calculates the seasons of the year.
  *
  * @author Gerhard Riegler - Initial contribution
- * @see based on the calculations of http://stellafane.org/misc/equinox.html
+ * @implNote based on the calculations of http://stellafane.org/misc/equinox.html
  */
 public class SeasonCalc {
     private int currentYear;

bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SunCalc.java

@@ -35,7 +35,7 @@ import org.openhab.binding.astro.internal.util.DateTimeUtils;
  *
  * @author Gerhard Riegler - Initial contribution
  * @author Christoph Weitkamp - Introduced UoM
- * @see based on the calculations of http://www.suncalc.net
+ * @implNote based on the calculations of http://www.suncalc.net
  */
 public class SunCalc {
     private static final double J2000 = 2451545.0;

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

@@ -177,7 +177,7 @@ public class AsuswrtRouter extends BaseBridgeHandler {
     /**
      * Stops a scheduler.
      *
-     * @param scheduler ScheduledFeature<?> which should be stopped
+     * @param scheduler {@code ScheduledFeature<?>} which should be stopped
      */
     protected void stopScheduler(@Nullable ScheduledFuture<?> scheduler) {
         if (scheduler != null) {

bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/discovery/AtlonaDiscovery.java

@@ -252,7 +252,7 @@ public class AtlonaDiscovery extends AbstractDiscoveryService {
      * {@inheritDoc}
      *
      * Stops the discovery scan. We set {@link #scanning} to false (allowing the listening threads to end naturally
-     * within {@link #TIMEOUT) * 5 time then shutdown the {@link #executorService}
+     * within {@link #TIMEOUT} * 5 time then shutdown the {@link ExecutorService}
      */
     @Override
     protected synchronized void stopScan() {

bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java

@@ -62,13 +62,13 @@ import org.xml.sax.InputSource;
  * binding allows openHAB to both monitor and control a pool system through
  * these controllers.
  *
- * @see <a href="http://Autelis.com">http://autelis.com</a>
+ * The {@link AutelisHandler} is responsible for handling commands, which
- * @see <a href="http://www.autelis.com/wiki/index.php?title=Pool_Control_HTTP_Command_Reference"</a> for Jandy API
+ * are sent to one of the channels.
- * @see <a href="http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference"</a> for Pentair
- *      API
  *
- *      The {@link AutelisHandler} is responsible for handling commands, which
+ * @see <a href="http://Autelis.com">http://autelis.com</a>
- *      are sent to one of the channels.
+ * @see <a href="http://www.autelis.com/wiki/index.php?title=Pool_Control_HTTP_Command_Reference">for Jandy API</a>
+ * @see <a href="http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference">for Pentair
+ *      API</a>
  *
  * @author Dan Cunningham - Initial contribution
  * @author Svilen Valkanov - Replaced Apache HttpClient with Jetty

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

@@ -29,6 +29,7 @@ import javax.xml.bind.annotation.XmlType;
  * devicelist version 1 (currently used by AVM) response:
  *
  * <pre>
+ * {@code
  * <devicelist version="1">
  * <device identifier="##############" id="##" functionbitmask="2944" fwversion="03.83" manufacturer="AVM" productname=
  * "FRITZ!DECT 200">
@@ -73,8 +74,8 @@ import javax.xml.bind.annotation.XmlType;
  * </hkr>
  * </device>
  * </devicelist>
- *
+ * }
- * <pre>
+ * </pre>
  *
  * @author Robert Bausdorf - Initial contribution
  * @author Christoph Weitkamp - Added support for groups

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

@@ -222,8 +222,8 @@ public class HeatingModel implements BatteryModel {
 
     /**
      * Converts a celsius value to a FRITZ!Box value.
-     * Valid celsius values: 8 to 28 °C > 16 to 56
+     * Valid celsius values: 8 to 28 °C > 16 to 56,
-     * 16 <= 8°C, 17 = 8.5°C...... 56 >= 28°C, 254 = ON, 253 = OFF
+     * 16 &lt;= 8°C, 17 = 8.5°C...... 56 >= 28°C, 254 = ON, 253 = OFF
      *
      * @param celsiusValue The celsius value to be converted
      * @return The FRITZ!Box value

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

@@ -220,7 +220,7 @@ public class FritzAhaWebInterface {
      * Constructs an URL from the stored information, a specified path and a specified argument string
      *
      * @param path Path to include in URL
-     * @param args String of arguments, in standard HTTP format (arg1=value1&arg2=value2&...)
+     * @param args String of arguments, in standard HTTP format ({@code arg1=value1&arg2=value2&...})
      * @return URL
      */
     public String getURL(String path, String args) {

bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/util/HeritableFuture.java

@@ -57,7 +57,7 @@ public class HeritableFuture<T> extends CompletableFuture<T> {
      *
      * {@inheritDoc}
      *
-     * @implSpec
+     * @implNote
      *           This implementation returns a new HeritableFuture instance that uses
      *           the current instance as a parent. Cancellation of the child will result in
      *           cancellation of the parent.
@@ -85,7 +85,7 @@ public class HeritableFuture<T> extends CompletableFuture<T> {
      *
      * {@inheritDoc}
      *
-     * @implSpec
+     * @implNote
      *           This implementation cancels this future first, then cancels the parent future.
      */
     @Override
@@ -107,7 +107,7 @@ public class HeritableFuture<T> extends CompletableFuture<T> {
      *
      * {@inheritDoc}
      *
-     * @implSpec
+     * @implNote
      *           This implementation will treat the future returned by the function as a parent future.
      */
     @Override
@@ -120,7 +120,7 @@ public class HeritableFuture<T> extends CompletableFuture<T> {
      *
      * {@inheritDoc}
      *
-     * @implSpec
+     * @implNote
      *           This implementation will treat the future returned by the function as a parent future.
      */
     @Override
@@ -133,7 +133,7 @@ public class HeritableFuture<T> extends CompletableFuture<T> {
      *
      * {@inheritDoc}
      *
-     * @implSpec
+     * @implNote
      *           This implementation will treat the future returned by the function as a parent future.
      */
     @Override

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

@@ -67,7 +67,6 @@ public class BPUPListener implements Runnable {
      * Constructor of the receiver runnable thread.
      *
      * @param bridgeHandler The handler of the Bond Bridge
-     * @throws SocketException is some problem occurs opening the socket.
      */
     public BPUPListener(BondBridgeHandler bridgeHandler) {
         logger.debug("Starting BPUP Listener...");

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

@@ -261,8 +261,8 @@ public class IndegoController {
     /**
      * Sends a PUT/POST request to the server.
      * 
-     * @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or
+     * @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod#PUT} or
-     *            {@link org.eclipse.jetty.http.HttpMethod.POST})
+     *            {@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/IndegoDeviceController.java

@@ -281,7 +281,7 @@ public class IndegoDeviceController extends IndegoController {
     }
 
     /**
-     * Request map position updates for the next ({@link count} * {@link interval}) number of seconds.
+     * Request map position updates for the next ({@code count} * {@code interval}) number of seconds.
      * 
      * @param count number of updates
      * @param interval number of seconds between updates

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

@@ -25,7 +25,9 @@ public class IndegoTypeDatabase {
     /**
      * Return tool name from tool type number.
      *
-     * @see https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego
+     * @see <a href=
+     *      "https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego">
+     *      https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego</a>
      *
      * @param toolTypeNumber condensed tool type number, e.g. "3600HA2200" rather than "3 600 HA2 200".
      * @return tool type name

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

@@ -113,8 +113,7 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
     public abstract @Nullable String getBoschID();
 
     /**
-     * Initializes this handler. Use this method to register all services of the device with
+     * Initializes this handler.
-     * {@link #registerService(TService, Consumer<TState>, Collection<String>, boolean)}.
      */
     @Override
     public void initialize() {
@@ -165,7 +164,8 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
     }
 
     /**
-     * Should be used by handlers to create their required services.
+     * Use this method to register all services of the device with
+     * {@link #registerService(BoschSHCService, Consumer, Collection, boolean)}.
      */
     protected void initializeServices() throws BoschSHCException {
     }
@@ -193,7 +193,7 @@ public abstract class BoschSHCHandler extends BaseThingHandler {
     /**
      * Query the Bosch Smart Home Controller for the state of the service with the specified name.
      *
-     * @note Use services instead of directly requesting a state.
+     * @implNote Use services instead of directly requesting a state.
      *
      * @param stateName Name of the service to query
      * @param classOfT Class to convert the resulting JSON to

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

@@ -44,7 +44,7 @@ import org.slf4j.LoggerFactory;
 import com.google.gson.JsonSyntaxException;
 
 /**
- * HTTP client using own context with private & Bosch Certs
+ * HTTP client using own context with private and Bosch Certs
  * to pair and connect to the Bosch Smart Home Controller.
  *
  * @author Gerd Zanker - 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 BoseSoundTouchBindinConstants} class defines common constants, which are
+ * The {@link BoseSoundTouchBindingConstants} 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

@@ -66,7 +66,7 @@ public class CommandExecutor implements AvailableSources {
      * Synchronizes the underlying storage container with the current value for the presets stored on the player
      * by updating the available ones and deleting the cleared ones
      *
-     * @param playerPresets a Map<Integer, ContentItems> containing the items currently stored on the player
+     * @param playerPresets a {@code Map<Integer, ContentItems>} containing the items currently stored on the player
      */
     public void updatePresetContainerFromPlayer(Map<Integer, ContentItem> playerPresets) {
         playerPresets.forEach((k, v) -> {

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

@@ -71,7 +71,7 @@ public interface SmartherAccountHandler extends ThingHandler {
      *
      * @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 Smarther API
      */
     List<Plant> getPlants() throws SmartherGatewayException;

bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/model/ModuleSettings.java

@@ -79,7 +79,7 @@ public class ModuleSettings {
      * @param chronothermostat
      *            the chronothermostat dto to get data from
      * 
-     * @throws {@link SmartherIllegalPropertyValueException}
+     * @throws SmartherIllegalPropertyValueException
      *             if at least one of the module properties cannot be mapped to any valid enum value
      */
     public void updateFromChronothermostat(Chronothermostat chronothermostat)

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

@@ -116,7 +116,7 @@ public final class DateUtil {
      *
      * @return a string representing the local date and time object
      *
-     * @throws DateTimeException if an error occurs during printing
+     * @throws DateTimeParseException if an error occurs during printing
      */
     public static String format(LocalDateTime date, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -133,7 +133,7 @@ public final class DateUtil {
      *
      * @return a string representing the date and time with timezone object
      *
-     * @throws DateTimeException if an error occurs during printing
+     * @throws DateTimeParseException if an error occurs during printing
      */
     public static String format(ZonedDateTime date, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -153,7 +153,7 @@ public final class DateUtil {
      *
      * @return a string representing the range between the two local date and time objects
      *
-     * @throws DateTimeException if an error occurs during printing
+     * @throws DateTimeParseException if an error occurs during printing
      */
     public static String formatRange(LocalDateTime date1, LocalDateTime date2, String pattern) {
         DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
@@ -174,7 +174,7 @@ public final class DateUtil {
      *
      * @return a string representing the range between the two date and time with timezone objects
      *
-     * @throws DateTimeException if an error occurs during printing
+     * @throws DateTimeParseException 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.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinBindingConstants.java

@@ -24,8 +24,8 @@ import org.openhab.core.thing.ThingTypeUID;
  * The {@link DaikinBindingConstants} class defines common constants, which are
  * used across the whole binding.
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  */
 @NonNullByDefault
 public class DaikinBindingConstants {

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinCommunicationException.java

@@ -19,7 +19,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 /**
  * Exception for when an unexpected response is received from the Daikin controller.
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
  *
  */
 @NonNullByDefault

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinHandlerFactory.java

@@ -30,8 +30,8 @@ import org.osgi.service.component.annotations.Reference;
  * The {@link DaikinHandlerFactory} is responsible for creating things and thing
  * handlers.
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  * 
  */
 @Component(service = ThingHandlerFactory.class, configurationPid = "binding.daikin")

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinWebTargets.java

@@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory;
  * Handles performing the actual HTTP requests for communicating with Daikin air conditioning units.
  *
  * @author Tim Waterhouse - Initial Contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  * @author Jimmy Tanagra - Add support for https and Daikin's uuid authentication
  *         Implement connection retry
  *

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/ControlInfo.java

@@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory;
  * Class for holding the set of parameters used by set and get control info.
  *
  * @author Tim Waterhouse - Initial Contribution
- * @author Paul Smedley <paul@smedley.id.au> - mods for Daikin Airbase
+ * @author Paul Smedley - mods for Daikin Airbase
  *
  */
 @NonNullByDefault

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

@@ -19,7 +19,7 @@ import org.slf4j.LoggerFactory;
 /**
  * Container class for enums related to Daikin A/C systems
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
  * @author Lukas Agethen - Add special modes
  *
  */

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseControlInfo.java

@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
  * Class for holding the set of parameters used by set and get control info.
  *
  * @author Tim Waterhouse - Initial Contribution
- * @author Paul Smedley <paul@smedley.id.au> - Mods for Daikin Airbase Units
+ * @author Paul Smedley - Mods for Daikin Airbase Units
  *
  */
 @NonNullByDefault

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseEnums.java

@@ -19,8 +19,8 @@ import org.slf4j.LoggerFactory;
 /**
  * Container class for enums related to Daikin Airbase A/C systems
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
- * @author Paul Smedley <paul@smedley.id.au> - Mods for Daikin Airbase Units
+ * @author Paul Smedley - Mods for Daikin Airbase Units
  *
  */
 @NonNullByDefault

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/discovery/DaikinACUnitDiscoveryService.java

@@ -49,8 +49,8 @@ import org.slf4j.LoggerFactory;
 /**
  * Discovery service for Daikin AC units.
  *
- * @author Tim Waterhouse <tim@timwaterhouse.com> - Initial contribution
+ * @author Tim Waterhouse - Initial contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  *
  */
 @Component(service = DiscoveryService.class, configurationPid = "discovery.daikin")

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAcUnitHandler.java

@@ -50,7 +50,7 @@ import org.slf4j.LoggerFactory;
  * @author Tim Waterhouse - Initial Contribution
  * @author Paul Smedley - Modifications to support Airbase Controllers
  * @author Lukas Agethen - Added support for Energy Year reading, compressor frequency and powerful mode
- * @author Wouter Denayer - Added to support for weekly & daily energy reading
+ * @author Wouter Denayer - Added to support for weekly and daily energy reading
  *
  */
 @NonNullByDefault

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAirbaseUnitHandler.java

@@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory;
  * Handles communicating with a Daikin Airbase wifi adapter.
  *
  * @author Tim Waterhouse - Initial Contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  * @author Jimmy Tanagra - Support Airside and auto fan levels, DynamicStateDescription
  *
  */

bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinBaseHandler.java

@@ -48,7 +48,7 @@ import org.slf4j.LoggerFactory;
  * Base class that handles common tasks with a Daikin air conditioning unit.
  *
  * @author Tim Waterhouse - Initial Contribution
- * @author Paul Smedley <paul@smedley.id.au> - Modifications to support Airbase Controllers
+ * @author Paul Smedley - Modifications to support Airbase Controllers
  * @author Jimmy Tanagra - Split handler classes, support Airside and DynamicStateDescription
  *
  */

bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/dto/BridgeFullState.java

@@ -22,7 +22,7 @@ import org.openhab.binding.deconz.internal.types.ResourceType;
 /**
  * http://dresden-elektronik.github.io/deconz-rest-doc/configuration/
  * # Get full state
- * GET /api/<apikey>
+ * {@code GET /api/<apikey>}
  *
  * @author David Graeff - Initial contribution
  */

bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/DeletedSourceList.java

@@ -17,7 +17,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
- * Used to unmarshall <list> items of the <functiondelete> CommandRX.
+ * Used to unmarshall {@code <list>} items of the {@code <functiondelete>} CommandRX.
  *
  * @author Jan-Willem Veldhuis - Initial contribution
  */

bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/RenameSourceList.java

@@ -17,7 +17,7 @@ import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlRootElement;
 
 /**
- * Used to unmarshall <list> items of the <functionrename> CommandRX.
+ * Used to unmarshall {@code <list>} items of the {@code <functionrename>} CommandRX.
  *
  * @author Jan-Willem Veldhuis - Initial contribution
  */

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

@@ -31,8 +31,8 @@ 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 <a href="https://developers.deutschebahn.com/db-api-marketplace/apis/product/timetables">DB API
- *      Marketplace</a>
+ * Marketplace</a>
  * 
  * @author Sönke Küper - Initial contribution.
  * 

bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/connector/DSMRSerialSettings.java

@@ -21,10 +21,12 @@ import org.openhab.core.io.transport.serial.SerialPort;
  * This class does store 4 serial parameters (baudrate, databits, parity, stopbits)
  * for use in {@link DSMRSerialConnector}.
  *
- * This class can also convert a string setting (<speed> <databits><parity><stopbits>)
+ * This class can also convert a string setting
+ * ({@code <speed> <databits><parity><stopbits>})
  * to a {@link DSMRSerialSettings} object (e.g. 115200 8N1)
  *
  * @author M. Volaart - Initial contribution
+ * 
  * @author Hilbrand Bouwkamp - Removed auto detecting state checking from this class.
  */
 @NonNullByDefault

bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemObjectType.java

@@ -206,7 +206,7 @@ public enum CosemObjectType {
      *
      * e.g. If the list contains 4 descriptors and the last 2 are repeating, idx=6 will return the 4th descriptor.
      *
-     * The idx is < 0 or outside a non-repeating descriptorslist size null is returned
+     * The idx {@code is < 0} or outside a non-repeating descriptorslist size null is returned
      *
      * @param idx the CosemValueDescriptor to return
      * @return the CosemValueDescriptor or null if not found.

bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugBridgeConfiguration.java

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

bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchConnector.java

@@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory;
  * app. The meaning of the EcoTouch tags was provided by Waterkotte's technical
  * service (by an excerpt of a developer manual).
  *
- * @author Sebastian Held <sebastian.held@gmx.de> - Initial contribution
+ * @author Sebastian Held - Initial contribution
  * @since 1.5.0
  */
 

bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchException.java

@@ -19,7 +19,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
  *
  * Used to solve compiler warning: "Avoid throwing raw exception types".
  *
- * @author Sebastian Held <sebastian.held@gmx.de> - Initial contribution
+ * @author Sebastian Held - Initial contribution
  * @since 3.1.0
  */
 @NonNullByDefault

bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchTags.java

@@ -28,7 +28,7 @@ import org.eclipse.jdt.annotation.Nullable;
 /**
  * Represents all valid commands which could be processed by this binding
  *
- * @author Sebastian Held <sebastian.held@gmx.de> - Initial contribution
+ * @author Sebastian Held - Initial contribution
  * @since 1.5.0
  */
 @NonNullByDefault

bundles/org.openhab.binding.ekey/src/main/java/org/openhab/binding/ekey/internal/api/EkeyUdpPacketReceiver.java

@@ -27,7 +27,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  * This Class provides the DatagramSocket that listens for eKey packets on the network
- * This will run in a thread and can be interrupted by calling <code>stopListener()<code>
+ * This will run in a thread and can be interrupted by calling <code>stopListener()</code>
  * Before starting the thread initialization is required (mode, ip, port and deliminator)
  *
  * @author Hans-Jörg Merk - Initial contribution

bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeType.java

@@ -16,8 +16,9 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
  * Charge type for DatahubPricelist dataset.
- * See {@link https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info}}
+ *
- * 
+ * @see <a href="https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info">
+ *      https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info</a>
  * @author Jacob Laursen - Initial contribution
  */
 @NonNullByDefault

bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeTypeCode.java

@@ -16,10 +16,12 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
  * Charge type code for DatahubPricelist dataset.
- * See {@link https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info}}
+ *
  * These codes are defined by the individual grid companies.
  * For example, N1 uses "CD" for "Nettarif C" and "CD R" for "Rabat på nettarif N1 A/S".
  *
+ * @see <a href="https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info">
+ *      https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info</a>
  * @author Jacob Laursen - Initial contribution
  */
 @NonNullByDefault

bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/GlobalLocationNumber.java

@@ -16,8 +16,9 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 
 /**
  * Global Location Number.
- * See {@link https://www.gs1.org/standards/id-keys/gln}}
+ * 
- * The Global Location Number (GLN) can be used by companies to identify their locations.
+ * The <a href="https://www.gs1.org/standards/id-keys/gln">Global Location Number (GLN)</a>
+ * can be used by companies to identify their locations.
  *
  * @author Jacob Laursen - Initial contribution
  */

bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/discovery/EnOceanUsbSerialDiscoveryParticipant.java

@@ -31,7 +31,7 @@ import org.osgi.service.component.annotations.Component;
 /**
  * Discovery for Enocean USB dongles, integrated in USB-serial discovery by implementing a component of type
  * {@link UsbSerialDiscoveryParticipant}.
- * <p/>
+ * <p>
  * Currently, this {@link UsbSerialDiscoveryParticipant} supports the Enocean USB300 dongles.
  *
  * @author Aitor Iturrioz - initial contribution

bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/handler/EnOceanBridgeHandler.java

@@ -66,10 +66,8 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by
+ * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by {@link EnOceanBaseActuatorHandler}
- * {@link org.openhab.binding.enocean.internal.handler.EnOceanActuatorHandler} and
+ * and transferring received ESP3Packages to {@link EnOceanBaseSensorHandler}.
- * transferring received ESP3Packages to
- * {@link org.openhab.binding.enocean.internal.handler.EnOceanSensorHandler}.
  *
  * @author Daniel Weber - Initial contribution
  */

bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/response/BatteryStatus.java

@@ -32,12 +32,12 @@ public class BatteryStatus {
         LOW_HIGH,
 
         /**
-         * level0~5，<=1 for BATT low
+         * level0~5，{@literal <=1} for BATT low
          */
         LEVEL,
 
         /**
-         * level0~6，<=1 for BATT low, 6 = dc power supply
+         * level0~6，{@literal <=1} for BATT low, 6 = dc power supply
          */
         LEVEL_OR_DC,
 
@@ -47,7 +47,7 @@ public class BatteryStatus {
         VOLTAGE_BROAD_STEPS,
 
         /**
-         * val*0.02V if v<=1.2V BATT low
+         * val*0.02V if {@literal v<=1.2V} BATT low
          */
         VOLTAGE_FINE_STEPS
     }

bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/AbstractWeatherHandler.java

@@ -191,7 +191,6 @@ public abstract class AbstractWeatherHandler extends BaseThingHandler {
      *
      * @param channelUID channel UID
      * @param epochSecond value to update
-     * @param unit unit associated with the value
      */
     protected <T extends Quantity<T>> void updateEpochSecondStateIfLinked(ChannelUID channelUID, long epochSecond) {
         if (isLinked(channelUID)) {

bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/client/Client.java

@@ -51,13 +51,15 @@ import org.xml.sax.SAXException;
  *
  * Client for accessing FMI weather data
  *
+ * <p>
  * Subject to license terms https://en.ilmatieteenlaitos.fi/open-data
  *
- *
+ * @see <a href=
- * All weather stations:
+ *      "https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations&networkid=121&">
- * https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations&networkid=121&
+ *      All weather stations</a>
- * Networkid parameter isexplained in entries of
+ * @see <a href=
- * https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations
+ *      "https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations">
+ *      Networkid parameter is explained in entries of</a>
  *
  * @author Sami Salonen - Initial contribution
  *

bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/CitiesOfFinland.java

@@ -21,9 +21,9 @@ import org.openhab.binding.fmiweather.internal.client.Location;
 /**
  * Cities of Finland
  *
- * Originally parsed from (not available any more)
+ * Originally parsed from <a href=
- * https://opendata.fmi.fi/wfs?service=WFS&version=2.0.0&request=getFeature&storedquery_id=fmi::forecast::hirlam::surface::cities::multipointcoverage
+ * "https://opendata.fmi.fi/wfs?service=WFS&version=2.0.0&request=getFeature&storedquery_id=fmi::forecast::hirlam::surface::cities::multipointcoverage">
- * 
+ * (not available any more)</a>
  *
  * Using piece of code similar to below:
  *

bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/FroniusBindingConstants.java

@@ -22,7 +22,7 @@ import org.openhab.core.thing.ThingTypeUID;
  * @author Thomas Rokohl - Initial contribution
  * @author Peter Schraffl - Added device status and error status channels
  * @author Thomas Kordelle - Added inverter power, battery state of charge and PV solar yield
- * @author Hannes Spenger - Added ohmpilot & meter power sum
+ * @author Hannes Spenger - Added ohmpilot and meter power sum
  * @author Jimmy Tanagra - Implement a common url parsing method
  */
 @NonNullByDefault

bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioApiResult.java

@@ -34,9 +34,11 @@ import org.xml.sax.SAXException;
  * this:
  *
  * <pre>
+ * {@code
  * <xmp>
  *   <fsapiResponse> <status>FS_OK</status> <value><u8>1</u8></value> </fsapiResponse>
  * </xmp>
+ * }
  * </pre>
  *
  * This class parses this XML data and provides functions for reading and casting typical fields.

bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/GardenaSmartWebSocketListener.java

@@ -24,7 +24,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
 @NonNullByDefault
 public interface GardenaSmartWebSocketListener {
     /**
-     * This method is called, when the evenRunner stops abnormally (statuscode <> 1000).
+     * This method is called, when the evenRunner stops abnormally ({@code statuscode <> 1000}).
      */
     void onWebSocketClose(String id);
 

bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/GreeBindingConstants.java

@@ -168,7 +168,9 @@ public class GreeBindingConstants {
      * temperature value shown on the device LCD display should match the value shown by this binding when the config
      * parameter currentTemperatureOffset is set to 0.
      *
-     * @see https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor
+     * @see <a href=
+     *      "https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor">
+     *      https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor</a>
      *      for more details.
      */
     public static final double INTERNAL_TEMP_SENSOR_OFFSET = -40.0;

bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/handler/GreeAirDevice.java

@@ -213,7 +213,7 @@ public class GreeAirDevice {
 
     /**
      * SwingLfRig: controls the swing mode of the horizontal air blades (available on limited number of devices, e.g.
-     * some Cooper & Hunter units - thanks to mvmn)
+     * some Cooper and Hunter units - thanks to mvmn)
      *
      * 0: default
      * 1: full swing

bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/exceptions/HubShadeTimeoutException.java

@@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
  * The {@link HubShadeTimeoutException} is a custom exception for the HD PowerView Hub
  * which is thrown when a shade does not respond to a request.
  *
- * @author @author Jacob Laursen - Initial contribution
+ * @author Jacob Laursen - Initial contribution
  */
 @NonNullByDefault
 public class HubShadeTimeoutException extends HubException {

bundles/org.openhab.binding.heliosventilation/src/main/java/org/openhab/binding/heliosventilation/internal/HeliosVentilationDataPoint.java

@@ -23,7 +23,7 @@ import org.openhab.core.types.State;
 import org.openhab.core.types.UnDefType;
 
 /**
- * The {@next HeliosVentilationDataPoint} is a description of a datapoint in the Helios ventilation system.
+ * The {@link HeliosVentilationDataPoint} is a description of a datapoint in the Helios ventilation system.
  *
  * @author Raphael Mack - Initial contribution
  */

bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/api/HeosFacade.java

@@ -494,7 +494,7 @@ public class HeosFacade {
     /**
      * Ask for the actual shuffle mode of the player. The result has
      * to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON},
-     * {@link HeosConstants#HEOS_REPEAT_ALL} or {@link HeosConstants#HEOS_REPEAT_ONE}
+     * {@link HeosConstants#REPEAT_ALL} or {@link HeosConstants#REPEAT_ONE}
      *
      * @param id The player id the shuffle mode shall get for
      * @return

bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java

@@ -132,7 +132,7 @@ public class Telnet {
      * @return A list with all read commands
      * @throws ReadException
      * @throws IOException
-     * @see Telnet.readLine(int timeOut).
+     * @see #readLine(int timeOut)
      */
     public String readLine() throws ReadException, IOException {
         return readLine(READ_TIMEOUT);

bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/common/HomematicConfig.java

@@ -360,7 +360,7 @@ public class HomematicConfig {
     }
 
     /**
-     * Returns the encoding that is suitable on requests to & responds from the Homematic gateway.
+     * Returns the encoding that is suitable on requests to and responds from the Homematic gateway.
      */
     public Charset getEncoding() {
         if (gatewayInfo != null && gatewayInfo.isHomegear()) {

bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicConfigDescriptionProvider.java

@@ -51,7 +51,7 @@ public interface HomematicConfigDescriptionProvider extends ConfigDescriptionPro
      * which are excluded by
      * {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
      * 
-     * @param URI config-description-uri
+     * @param uri config-description-uri
      *            e.g. <i>thing-type:homematic:HM-WDS40-TH-I-2</i>
      * @return ConfigDescription that was added to HomematicConfigDescriptionProvider,
      *         identified by its config-description-uri<br>

bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicThingTypeProvider.java

@@ -32,7 +32,7 @@ public interface HomematicThingTypeProvider extends ThingTypeProvider {
      * Use this method to lookup a ThingType which was generated by the
      * homematic binding. Other than {@link #getThingType(ThingTypeUID, Locale)}
      * of this provider, it will return also those {@link ThingType}s which are
-     * excluded by {@link HomematicThingTypeExcluder}
+     * excluded by {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
      * 
      * @param thingTypeUID
      *            e.g. <i>homematic:HM-Sec-SC</i>

bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/Resource.java

@@ -203,7 +203,7 @@ public class Resource {
 
     /**
      * Get the color as an HSBType. This returns an HSB that is based on an amalgamation of the color xy, dimming, and
-     * on/off JSON elements. It takes its 'H' & 'S' parts from the 'ColorXy' JSON element, and its 'B' part from the
+     * on/off JSON elements. It takes its 'H' and 'S' parts from the 'ColorXy' JSON element, and its 'B' part from the
      * on/off resp. dimming JSON elements. If off the B part is 0, otherwise it is the dimming element value. Note: this
      * method is only to be used on cached state DTOs which already have a defined color gamut.
      *

bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/ResourceReference.java

@@ -20,7 +20,7 @@ import org.openhab.binding.hue.internal.dto.clip2.enums.ResourceType;
  * DTO that contains an API reference element.
  *
  * The V2 API is set up in such a way that all resources of the same type are grouped together under the
- * /resource/<resourcetype> endpoint, but all those resources commonly reference each other, which is done in a
+ * {@code /resource/<resourcetype>} endpoint, but all those resources commonly reference each other, which is done in a
  * standardized way by indicating the resource type (rtype) and resource id (rid).
  *
  * A typical usage is in a single physical device that hosts multiple services. An existing example is the Philips Hue

bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/helper/Setters.java

@@ -80,7 +80,8 @@ public class Setters {
      * (if any).
      *
      * @param target the target resource.
-     * @param command the new state command should be a QuantityType<Temperature> (but it can also handle DecimalType).
+     * @param command the new state command should be a {@code QuantityType<Temperature>} (but it can also handle
+     *            {@code DecimalType}).
      * @param source another resource containing the MirekSchema.
      *
      * @return the target resource.

bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2ThingHandler.java

@@ -1091,7 +1091,7 @@ public class Clip2ThingHandler extends BaseThingHandler {
     }
 
     /**
-     * Fetch the full list of scenes from the bridge, and call updateSceneContributors(List<Resource> allScenes)
+     * Fetch the full list of scenes from the bridge, and call {@code updateSceneContributors(List<Resource> allScenes)}
      *
      * @throws ApiException if a communication error occurred.
      * @throws AssetNotLoadedException if one of the assets is not loaded.

bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/api/IAqualinkClient.java

@@ -225,7 +225,7 @@ public class IAqualinkClient {
      * @param sessionID
      * @param auxID
      * @param lightValue
-     * @param subtype
+     * @param subType
      * @return
      * @throws IOException
      * @throws NotAuthorizedException
@@ -244,10 +244,10 @@ public class IAqualinkClient {
     /**
      * Sends an Auxiliary dimmer command
      *
-     * @param serialNumber
+     * @param serial
-     * @param sessionId
+     * @param sessionID
-     * @param auxId
+     * @param auxID
-     * @param lightValue
+     * @param level
      * @return
      * @throws IOException
      * @throws NotAuthorizedException

bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/AbstractPresentableCalendar.java

@@ -25,7 +25,7 @@ import org.eclipse.jdt.annotation.Nullable;
  * the binding, encapsulating the implementation of the real calendar.
  *
  * @author Michael Wodniok - Initial contribution
- * @author Andrew Fiddian-Green - Methods getJustBegunEvents() & getJustEndedEvents()
+ * @author Andrew Fiddian-Green - Methods getJustBegunEvents() and getJustEndedEvents()
  * @author Michael Wodniok - Added getFilteredEventsBetween()
  */
 @NonNullByDefault

bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTag.java

@@ -36,10 +36,14 @@ import org.slf4j.LoggerFactory;
  * This is a class that implements a Command Tag that may be embedded in an
  * Event Description. Valid Tags must follow one of the following forms..
  *
+ * <pre>
+ * {@code
  * BEGIN:<itemName>:<targetState>
  * BEGIN:<itemName>:<targetState>:<authorizationCode>
  * END:<itemName>:<targetState>
  * END:<itemName>:<targetState>:<authorizationCode>
+ * }
+ * </pre>
  *
  * @author Andrew Fiddian-Green - Initial contribution
  */

bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java

@@ -18,8 +18,12 @@ import org.eclipse.jdt.annotation.Nullable;
 /**
  * A type enumerator to indicate whether a Command Tag is of type BEGIN or END; as in the following examples:
  *
+ * <pre>
+ * {@code
  * BEGIN:<item_name>:<new_state>
  * END:<item_name>:<new_state>
+ * }
+ * </pre>
  *
  * @author Andrew Fiddian-Green - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/Converter.java

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNull;
 import org.openhab.binding.ihc.internal.ws.exeptions.ConversionException;
 
 /**
- * IHC / ELKO <-> openHAB data type converter interface.
+ * IHC / ELKO {@literal <->} openHAB data type converter interface.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/ConverterFactory.java

@@ -34,7 +34,7 @@ import org.openhab.core.library.types.UpDownType;
 import org.openhab.core.types.Type;
 
 /**
- * IHC / ELKO <-> openHAB data type converter factory.
+ * IHC / ELKO {@literal <->} openHAB data type converter factory.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSDateValueConverter.java

@@ -24,7 +24,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSTimeValue;
 import org.openhab.core.library.types.DateTimeType;
 
 /**
- * DateTimeType <-> WSDateValue converter.
+ * DateTimeType {@literal <->} WSDateValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSTimeValueConverter.java

@@ -24,7 +24,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSTimeValue;
 import org.openhab.core.library.types.DateTimeType;
 
 /**
- * DateTimeType <-> WSTimeValue converter.
+ * DateTimeType {@literal <->} WSTimeValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSBooleanValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSBooleanValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSBooleanValue converter.
+ * DecimalType {@literal <->} WSBooleanValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSEnumValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSEnumValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSEnumValue converter.
+ * DecimalType {@literal <->} WSEnumValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSFloatingPointValueConverter.java

@@ -21,7 +21,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSFloatingPointValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSFloatingPointValue converter.
+ * DecimalType {@literal <->} WSFloatingPointValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSIntegerValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSIntegerValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSIntegerValue converter.
+ * DecimalType {@literal <->} WSIntegerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSTimerValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSTimerValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSTimerValue converter.
+ * DecimalType {@literal <->} WSTimerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSWeekdayValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSWeekdayValue;
 import org.openhab.core.library.types.DecimalType;
 
 /**
- * DecimalType <-> WSWeekdayValue converter.
+ * DecimalType {@literal <->} WSWeekdayValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSBooleanValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSBooleanValue;
 import org.openhab.core.library.types.OnOffType;
 
 /**
- * OnOffType <-> WSBooleanValue converter.
+ * OnOffType {@literal <->} WSBooleanValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSIntegerValueConverter.java

@@ -19,7 +19,7 @@ import org.openhab.core.library.types.OnOffType;
 import org.openhab.core.types.Command;
 
 /**
- * OnOffType <-> WSIntegerValue converter.
+ * OnOffType {@literal <->} WSIntegerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSBooleanValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSBooleanValue;
 import org.openhab.core.library.types.OpenClosedType;
 
 /**
- * OpenClosedType <-> WSBooleanValue converter.
+ * OpenClosedType {@literal <->} WSBooleanValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSIntegerValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSIntegerValue;
 import org.openhab.core.library.types.OpenClosedType;
 
 /**
- * OpenClosedType <-> WSIntegerValue converter.
+ * OpenClosedType {@literal <->} WSIntegerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/PercentTypeWSIntegerValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSIntegerValue;
 import org.openhab.core.library.types.PercentType;
 
 /**
- * PercentType <-> WSIntegerValue converter.
+ * PercentType {@literal <->} WSIntegerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/StringTypeWSEnumValueConverter.java

@@ -19,7 +19,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSEnumValue;
 import org.openhab.core.library.types.StringType;
 
 /**
- * StringType <-> WSEnumValue converter.
+ * StringType {@literal <->} WSEnumValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSBooleanValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSBooleanValue;
 import org.openhab.core.library.types.UpDownType;
 
 /**
- * UpDownType <-> WSBooleanValue converter.
+ * UpDownType {@literal <->} WSBooleanValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSIntegerValueConverter.java

@@ -18,7 +18,7 @@ import org.openhab.binding.ihc.internal.ws.resourcevalues.WSIntegerValue;
 import org.openhab.core.library.types.UpDownType;
 
 /**
- * UpDownType <-> WSIntegerValue converter.
+ * UpDownType {@literal <->} WSIntegerValue converter.
  *
  * @author Pauli Anttila - Initial contribution
  */

bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/services/IhcResourceInteractionService.java

@@ -13,7 +13,6 @@
 package org.openhab.binding.ihc.internal.ws.services;
 
 import java.io.IOException;
-import java.net.SocketTimeoutException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
@@ -442,7 +441,6 @@ public class IhcResourceInteractionService extends IhcBaseService {
      *
      * @param timeoutInSeconds How many seconds to wait notifications.
      * @return List of received runtime value notifications.
-     * @throws SocketTimeoutException
      * @throws IhcExecption
      */
     public List<WSResourceValue> waitResourceValueNotifications(int timeoutInSeconds) throws IhcExecption {

bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonAddress.java

@@ -77,7 +77,7 @@ public class InsteonAddress {
      * Constructor for an InsteonAddress that wraps an X10 address.
      * Simply stuff the X10 address into the lowest byte.
      *
-     * @param aX10HouseUnit the house & unit number as encoded by the X10 protocol
+     * @param aX10HouseUnit the house and unit number as encoded by the X10 protocol
      */
     public InsteonAddress(byte aX10HouseUnit) {
         highByte = 0;