From f24a4305b887f00116a062f4f5bf2a09048fd039 Mon Sep 17 00:00:00 2001 From: Holger Friedrich Date: Sun, 8 Oct 2023 00:25:04 +0200 Subject: [PATCH] Improve javadoc for some addons (#15701) Signed-off-by: Holger Friedrich --- .../watch/JRubyScriptFileWatcher.java | 2 +- .../internal/OpenhabGraalJSScriptEngine.java | 6 ++-- .../fs/watch/JSScriptFileWatcher.java | 2 +- .../internal/AhaCollectionSchedule.java | 2 ++ .../AirVisualNodeDiscoveryService.java | 3 +- .../internal/handler/ZoneHandler.java | 2 +- .../internal/protocol/ADCommand.java | 4 +-- .../binding/astro/internal/calc/MoonCalc.java | 6 ++-- .../astro/internal/calc/SeasonCalc.java | 2 +- .../binding/astro/internal/calc/SunCalc.java | 2 +- .../internal/things/AsuswrtRouter.java | 2 +- .../internal/discovery/AtlonaDiscovery.java | 2 +- .../internal/handler/AutelisHandler.java | 12 +++---- .../internal/dto/DeviceListModel.java | 5 +-- .../avmfritz/internal/dto/HeatingModel.java | 4 +-- .../hardware/FritzAhaWebInterface.java | 2 +- .../bluetooth/util/HeritableFuture.java | 10 +++--- .../bondhome/internal/api/BPUPListener.java | 1 - .../internal/IndegoController.java | 4 +-- .../internal/IndegoDeviceController.java | 2 +- .../internal/IndegoTypeDatabase.java | 4 ++- .../internal/devices/BoschSHCHandler.java | 8 ++--- .../devices/bridge/BoschHttpClient.java | 2 +- .../BoseSoundTouchBindingConstants.java | 2 +- .../internal/CommandExecutor.java | 2 +- .../account/SmartherAccountHandler.java | 2 +- .../internal/model/ModuleSettings.java | 2 +- .../internal/util/DateUtil.java | 8 ++--- .../internal/DaikinBindingConstants.java | 4 +-- .../DaikinCommunicationException.java | 2 +- .../daikin/internal/DaikinHandlerFactory.java | 4 +-- .../daikin/internal/DaikinWebTargets.java | 2 +- .../daikin/internal/api/ControlInfo.java | 2 +- .../binding/daikin/internal/api/Enums.java | 2 +- .../api/airbase/AirbaseControlInfo.java | 2 +- .../internal/api/airbase/AirbaseEnums.java | 4 +-- .../DaikinACUnitDiscoveryService.java | 4 +-- .../internal/handler/DaikinAcUnitHandler.java | 2 +- .../handler/DaikinAirbaseUnitHandler.java | 2 +- .../internal/handler/DaikinBaseHandler.java | 2 +- .../deconz/internal/dto/BridgeFullState.java | 2 +- .../entities/commands/DeletedSourceList.java | 2 +- .../entities/commands/RenameSourceList.java | 2 +- .../internal/TripLabelAttribute.java | 4 +-- .../device/connector/DSMRSerialSettings.java | 4 ++- .../device/cosem/CosemObjectType.java | 2 +- .../DWDPollenflugBridgeConfiguration.java | 2 +- .../ecotouch/internal/EcoTouchConnector.java | 2 +- .../ecotouch/internal/EcoTouchException.java | 2 +- .../ecotouch/internal/EcoTouchTags.java | 2 +- .../internal/api/EkeyUdpPacketReceiver.java | 2 +- .../internal/api/ChargeType.java | 5 +-- .../internal/api/ChargeTypeCode.java | 4 ++- .../internal/api/GlobalLocationNumber.java | 5 +-- .../EnOceanUsbSerialDiscoveryParticipant.java | 2 +- .../handler/EnOceanBridgeHandler.java | 6 ++-- .../domain/response/BatteryStatus.java | 6 ++-- .../internal/AbstractWeatherHandler.java | 1 - .../fmiweather/internal/client/Client.java | 12 ++++--- .../internal/discovery/CitiesOfFinland.java | 6 ++-- .../internal/FroniusBindingConstants.java | 2 +- .../radio/FrontierSiliconRadioApiResult.java | 2 ++ .../GardenaSmartWebSocketListener.java | 2 +- .../gree/internal/GreeBindingConstants.java | 4 ++- .../gree/internal/handler/GreeAirDevice.java | 2 +- .../exceptions/HubShadeTimeoutException.java | 2 +- .../internal/HeliosVentilationDataPoint.java | 2 +- .../binding/heos/internal/api/HeosFacade.java | 2 +- .../heos/internal/resources/Telnet.java | 2 +- .../internal/common/HomematicConfig.java | 2 +- .../HomematicConfigDescriptionProvider.java | 2 +- .../type/HomematicThingTypeProvider.java | 2 +- .../hue/internal/dto/clip2/Resource.java | 2 +- .../internal/dto/clip2/ResourceReference.java | 2 +- .../internal/dto/clip2/helper/Setters.java | 3 +- .../internal/handler/Clip2ThingHandler.java | 2 +- .../internal/api/IAqualinkClient.java | 10 +++--- .../logic/AbstractPresentableCalendar.java | 2 +- .../icalendar/internal/logic/CommandTag.java | 4 +++ .../internal/logic/CommandTagType.java | 4 +++ .../ihc/internal/converters/Converter.java | 2 +- .../internal/converters/ConverterFactory.java | 2 +- .../DateTimeTypeWSDateValueConverter.java | 2 +- .../DateTimeTypeWSTimeValueConverter.java | 2 +- .../DecimalTypeWSBooleanValueConverter.java | 2 +- .../DecimalTypeWSEnumValueConverter.java | 2 +- ...imalTypeWSFloatingPointValueConverter.java | 2 +- .../DecimalTypeWSIntegerValueConverter.java | 2 +- .../DecimalTypeWSTimerValueConverter.java | 2 +- .../DecimalTypeWSWeekdayValueConverter.java | 2 +- .../OnOffTypeWSBooleanValueConverter.java | 2 +- .../OnOffTypeWSIntegerValueConverter.java | 2 +- ...OpenClosedTypeWSBooleanValueConverter.java | 2 +- ...OpenClosedTypeWSIntegerValueConverter.java | 2 +- .../PercentTypeWSIntegerValueConverter.java | 2 +- .../StringTypeWSEnumValueConverter.java | 2 +- .../UpDownTypeWSBooleanValueConverter.java | 2 +- .../UpDownTypeWSIntegerValueConverter.java | 2 +- .../IhcResourceInteractionService.java | 2 -- .../internal/device/InsteonAddress.java | 2 +- .../internal/enums/IntesisHomeModeEnum.java | 2 +- .../KaleidescapeDiscoveryService.java | 2 +- .../KM200SwitchProgramServiceHandler.java | 2 +- bundles/org.openhab.binding.knx/pom.xml | 18 ----------- .../kodi/internal/KodiBindingConstants.java | 2 +- .../kodi/internal/handler/KodiHandler.java | 2 +- .../internal/protocol/KodiConnection.java | 2 +- .../internal/handler/KonnectedHandler.java | 4 +-- .../imported/RuntimeTypeAdapterFactory.java | 4 +-- .../internal/discovery/LGHomBotDiscovery.java | 2 +- .../binding/lifx/internal/LifxProduct.java | 3 +- .../lifx/internal/dto/SignalStrength.java | 8 ++--- .../internal/handler/LivisiBridgeHandler.java | 4 +-- .../internal/listener/EventListener.java | 2 +- .../lutron/internal/handler/CcoHandler.java | 6 ++-- .../discovery/LuxtronikHeatpumpDiscovery.java | 2 +- .../internal/handler/MagentaTVControl.java | 31 ++++++++++++++----- .../network/MagentaTVNotifyServlet.java | 15 +++++++-- .../openhab/binding/max/internal/Utils.java | 2 +- .../max/internal/command/MCommand.java | 2 +- .../max/internal/command/SCommand.java | 4 +-- .../config/MaxCubeBridgeConfiguration.java | 3 +- .../binding/max/internal/device/Device.java | 2 +- .../internal/device/DeviceConfiguration.java | 2 +- .../internal/device/DeviceInformation.java | 2 +- .../max/internal/device/DeviceType.java | 2 +- .../internal/device/HeatingThermostat.java | 4 +-- .../max/internal/device/RoomInformation.java | 4 +-- .../max/internal/device/ShutterContact.java | 2 +- .../internal/device/ThermostatModeType.java | 2 +- .../internal/device/UnsupportedDevice.java | 2 +- .../device/WallMountedThermostat.java | 2 +- .../IncompleteMessageException.java | 2 +- .../IncorrectMultilineIndexException.java | 2 +- .../exceptions/MessageIsWaitingException.java | 2 +- .../NoMessageAvailableException.java | 2 +- .../UnprocessableMessageException.java | 2 +- .../UnsupportedMessageTypeException.java | 2 +- .../handler/MaxCubeBridgeHandler.java | 2 +- .../max/internal/message/CMessage.java | 2 +- .../max/internal/message/HMessage.java | 2 +- .../max/internal/message/LMessage.java | 2 +- .../max/internal/message/MMessage.java | 2 +- .../max/internal/message/MaxTokenizer.java | 2 +- .../binding/max/internal/message/Message.java | 2 +- .../internal/message/MessageProcessor.java | 2 +- .../max/internal/message/MessageType.java | 2 +- .../max/internal/message/CMessageTest.java | 2 +- .../internal/message/ConfigurationTest.java | 2 +- .../message/MessageProcessorTest.java | 2 +- .../max/internal/message/UtilsTest.java | 2 +- .../internal/handler/McdBridgeHandler.java | 2 +- .../miele/internal/MieleBindingConstants.java | 2 +- .../internal/handler/MieleBridgeHandler.java | 2 +- .../mihome/internal/EncryptionHelper.java | 2 +- .../binding/mihome/internal/ModelMapper.java | 3 +- .../handler/XiaomiActorGatewayHandler.java | 2 +- .../handler/XiaomiSensorHtHandler.java | 2 +- .../protocol/MilightV6SessionManager.java | 7 ++++- .../e3dc/internal/dto/EmergencyBlock.java | 2 +- .../modbus/internal/AtomicStampedValue.java | 1 - .../mapping/AbstractMqttAttributeClass.java | 2 ++ .../mybmw/internal/MyBMWConstants.java | 2 +- .../internal/dto/charge/ChargeProfile.java | 2 +- .../mybmw/internal/dto/charge/Time.java | 2 +- .../mybmw/internal/dto/charge/Timer.java | 2 +- .../mybmw/internal/handler/MyBMWProxy.java | 11 ++++--- .../handler/RemoteServiceHandler.java | 5 +-- .../handler/VehicleChannelHandler.java | 2 +- .../internal/handler/VehicleHandler.java | 2 +- .../mybmw/internal/utils/BimmerConstants.java | 8 +++-- .../nest/internal/sdm/api/PubSubAPI.java | 6 ++-- .../binding/nest/internal/sdm/api/SDMAPI.java | 3 +- .../sdm/discovery/SDMDiscoveryService.java | 3 +- .../sdm/dto/PubSubRequestsResponses.java | 3 +- .../nest/internal/sdm/dto/SDMCommands.java | 3 +- .../nest/internal/sdm/dto/SDMError.java | 3 +- .../nest/internal/sdm/dto/SDMEvent.java | 3 +- .../sdm/dto/SDMListDevicesResponse.java | 3 +- .../sdm/dto/SDMListRoomsResponse.java | 3 +- .../sdm/dto/SDMListStructuresResponse.java | 3 +- .../network/internal/PresenceDetection.java | 2 +- .../toberemoved/cache/ExpiringCacheAsync.java | 2 +- .../AbstractUplinkCommandCallback.java | 2 +- .../internal/protocol/NhcThermostat.java | 2 +- .../internal/protocol/NhcThermostatEvent.java | 2 +- .../internal/discovery/OwDiscoveryItem.java | 2 +- .../opengarage/internal/api/Enums.java | 2 +- .../internal/api/OpenSprinklerApi.java | 8 ++--- .../discovery/OppoDiscoveryService.java | 2 +- .../internal/communication/SyncQueue.java | 2 +- .../binding/pilight/internal/dto/Code.java | 3 +- .../binding/pilight/internal/dto/Config.java | 3 +- .../binding/pilight/internal/dto/Version.java | 3 +- .../protocol/StreamAvrConnection.java | 6 ++-- .../internal/PS4ArtworkHandler.java | 4 +-- .../internal/message/PowermaxCommManager.java | 5 +-- .../binding/pushsafer/internal/dto/Icon.java | 2 +- .../data/RemoteopenhabCommandOptions.java | 2 +- .../data/RemoteopenhabStateOptions.java | 2 +- .../messages/RFXComLighting4Message.java | 10 +++++- .../messages/RFXComThermostat3Message.java | 2 +- .../robonect/internal/RobonectClient.java | 3 +- .../robonect/internal/model/ErrorEntry.java | 4 ++- .../internal/model/cmd/StatusCommand.java | 3 +- .../internal/rio/RioPresetsProtocol.java | 8 ++--- .../rio/RioSystemFavoritesProtocol.java | 4 +-- .../russound/internal/rio/models/RioBank.java | 4 +-- .../internal/rio/models/RioFavorite.java | 4 +-- .../internal/rio/models/RioPreset.java | 4 +-- .../internal/rio/source/RioSourceHandler.java | 3 +- .../samsungtv/internal/WakeOnLanUtility.java | 2 +- .../internal/dto/StatusResponse.java | 2 +- .../SensiboTemperatureUnitConverter.java | 2 +- .../internal/api1/Shelly1CoIoTProtocol.java | 4 +-- .../internal/handler/ShellyComponents.java | 2 +- .../handler/ShellyDeviceListener.java | 3 +- .../provider/ShellyChannelDefinitions.java | 4 +-- ...SilvercrestWifiSocketDiscoveryService.java | 2 +- .../binding/smartmeter/internal/ObisCode.java | 3 +- .../conformity/negate/NegateHandler.java | 2 +- .../AbstractDataResponseTransformer.java | 16 +++++----- .../handler/EnergyManagerHandler.java | 2 +- .../SomfyTahomaRollerShutterHandler.java | 2 +- .../sonos/internal/SonosResourceMetaData.java | 2 +- .../internal/handler/ZonePlayerHandler.java | 4 +-- .../sonos/internal/util/StringUtils.java | 12 ++++++- .../internal/SysteminfoThingTypeProvider.java | 3 +- .../internal/model/SysteminfoInterface.java | 2 +- .../internal/api/TapoDeviceConnector.java | 4 +-- .../internal/device/TapoBridgeHandler.java | 2 +- .../internal/device/TapoDevice.java | 2 +- .../internal/helpers/TapoUtils.java | 12 +++---- .../internal/structures/TapoSubRequest.java | 2 +- .../reader/io/serialport/FrameUtil.java | 3 +- .../handler/DeviceStatusListener.java | 5 +-- .../tivo/internal/service/TivoConfigData.java | 3 +- .../tivo/internal/service/TivoStatusData.java | 2 +- .../internal/service/TivoStatusProvider.java | 3 +- .../config/TouchwandBridgeConfiguration.java | 2 +- .../tradfri/internal/TradfriColor.java | 6 ++-- .../internal/util/StringUtils.java | 10 ++++++ .../internal/util/UpnpProtocolMatcher.java | 4 +-- .../velux/internal/action/VeluxActions.java | 3 +- .../internal/handler/VeluxBridgeHandler.java | 3 +- .../dto/responses/VeSyncUserSession.java | 2 +- .../internal/mapping/VolumioCommands.java | 6 ++-- .../internal/action/VolvoOnCallActions.java | 2 +- .../webthing/internal/link/TypeMapping.java | 4 +-- .../wemo/internal/WemoHttpCallFactory.java | 2 +- .../WiFiLEDDiscoveryServiceTestApp.java | 2 +- .../internal/api/AuthenticationHelper.java | 10 ++++-- .../internal/dto/KeyResponse.java | 3 +- .../protocol/InputWithNavigationControl.java | 21 ++++++++----- .../protocol/xml/AbstractInputControlXML.java | 4 ++- .../protocol/xml/DeviceInformationXML.java | 5 +++ .../xml/InputWithNavigationControlXML.java | 2 +- .../protocol/xml/InputWithPlayControlXML.java | 2 +- .../xml/InputWithPresetControlXML.java | 2 +- .../xml/InputWithTunerDABControlXML.java | 2 +- .../internal/protocol/xml/XMLConnection.java | 4 +-- .../internal/protocol/xml/XMLUtils.java | 4 ++- .../internal/state/AvailableInputState.java | 2 +- .../AbstractHomekitAccessoryImpl.java | 5 +++ .../io/hueemulation/internal/RuleUtils.java | 4 +-- .../jersey/filter/LoggingFilter.java | 2 +- .../internal/models/NeeoDeviceTiming.java | 2 +- .../influxdb/InfluxDBPersistenceService.java | 4 +-- .../influxdb/internal/InfluxDBRepository.java | 2 +- .../jdbc/internal/utils/StringUtilsExt.java | 7 ++++- .../voice/mactts/internal/MacTTSVoice.java | 6 ++-- .../binding/astro/test/AstroStateTest.java | 2 +- .../internal/AbstractHueOSGiTestParent.java | 1 + .../internal/util/ReflectionUtil.java | 2 -- pom.xml | 12 +++++++ 275 files changed, 547 insertions(+), 406 deletions(-) diff --git a/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/watch/JRubyScriptFileWatcher.java b/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/watch/JRubyScriptFileWatcher.java index b2712a533..4d6f05da2 100644 --- a/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/watch/JRubyScriptFileWatcher.java +++ b/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 /automation/ruby for Ruby files, but not libraries in lib or gems + * Monitors {@code /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 diff --git a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java index 3233ab745..1264e9131 100644 --- a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java +++ b/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 { @@ -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 - * lifecycle and provides hooks for scripts to do so too. + * Creates an implementation of ScriptEngine {@code (& Invocable)}, wrapping the contained engine, + * that tracks the script lifecycle and provides hooks for scripts to do so too. */ public OpenhabGraalJSScriptEngine(boolean injectionEnabled, boolean injectionCachingEnabled, JSScriptServiceUtil jsScriptServiceUtil, JSDependencyTracker jsDependencyTracker) { diff --git a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/fs/watch/JSScriptFileWatcher.java b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/fs/watch/JSScriptFileWatcher.java index 239018265..f3f048a4f 100644 --- a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/fs/watch/JSScriptFileWatcher.java +++ b/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 /automation/js for Javascript files, but not libraries + * Monitors {@code /automation/js} for Javascript files, but not libraries * * @author Jonathan Gilbert - Initial contribution * @author Jan N. Klug - Refactored to new WatchService diff --git a/bundles/org.openhab.binding.ahawastecollection/src/main/java/org/openhab/binding/ahawastecollection/internal/AhaCollectionSchedule.java b/bundles/org.openhab.binding.ahawastecollection/src/main/java/org/openhab/binding/ahawastecollection/internal/AhaCollectionSchedule.java index 52d971227..dbda9fb1b 100644 --- a/bundles/org.openhab.binding.ahawastecollection/src/main/java/org/openhab/binding/ahawastecollection/internal/AhaCollectionSchedule.java +++ b/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 getCollectionDates() throws IOException; } diff --git a/bundles/org.openhab.binding.airvisualnode/src/main/java/org/openhab/binding/airvisualnode/internal/discovery/AirVisualNodeDiscoveryService.java b/bundles/org.openhab.binding.airvisualnode/src/main/java/org/openhab/binding/airvisualnode/internal/discovery/AirVisualNodeDiscoveryService.java index ce6ebbd51..e9391bc7d 100644 --- a/bundles/org.openhab.binding.airvisualnode/src/main/java/org/openhab/binding/airvisualnode/internal/discovery/AirVisualNodeDiscoveryService.java +++ b/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-'. + * Autodiscovery for AirVisual Node by searching for a host advertised with the NetBIOS name + * {@code 'AVISUAL-'}. * * @author Victor Antonovich - Initial contribution */ diff --git a/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/handler/ZoneHandler.java b/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/handler/ZoneHandler.java index 952f40fa1..eb634be96 100644 --- a/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/handler/ZoneHandler.java +++ b/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 diff --git a/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/protocol/ADCommand.java b/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/protocol/ADCommand.java index 193f102d2..7bfbd5552 100644 --- a/bundles/org.openhab.binding.alarmdecoder/src/main/java/org/openhab/binding/alarmdecoder/internal/protocol/ADCommand.java +++ b/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 - * command will be created. The validity of configParam is not checked. + * If configParam consists of one or more NAME=value pairs (separated by {@code '&'} characters), a set + * 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 diff --git a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/MoonCalc.java b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/MoonCalc.java index ad0a06fed..516af4f55 100644 --- a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/MoonCalc.java +++ b/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 - * http://www.computus.de/mondphase/mondphase.htm azimuth/elevation and - * zodiac based on http://lexikon.astronomie.info/java/sunmoon/ + * @implNote based on the calculations of + * http://www.computus.de/mondphase/mondphase.htm azimuth/elevation and + * zodiac based on http://lexikon.astronomie.info/java/sunmoon/ */ public class MoonCalc { private static final double NEW_MOON = 0; diff --git a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SeasonCalc.java b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SeasonCalc.java index 85d56291b..bfc3e4303 100644 --- a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SeasonCalc.java +++ b/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; diff --git a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SunCalc.java b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SunCalc.java index e850cabb9..3753454e8 100644 --- a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/calc/SunCalc.java +++ b/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; diff --git a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/things/AsuswrtRouter.java b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/things/AsuswrtRouter.java index e2b6922d4..205976298 100644 --- a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/things/AsuswrtRouter.java +++ b/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) { diff --git a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/discovery/AtlonaDiscovery.java b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/discovery/AtlonaDiscovery.java index d7ff33424..eb9a659f8 100644 --- a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/discovery/AtlonaDiscovery.java +++ b/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() { diff --git a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java b/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java index 010371d04..f2ededc24 100644 --- a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/handler/AutelisHandler.java +++ b/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 http://autelis.com - * @see for Jandy API - * @see for Pentair - * API + * The {@link AutelisHandler} is responsible for handling commands, which + * are sent to one of the channels. * - * The {@link AutelisHandler} is responsible for handling commands, which - * are sent to one of the channels. + * @see http://autelis.com + * @see for Jandy API + * @see for Pentair + * API * * @author Dan Cunningham - Initial contribution * @author Svilen Valkanov - Replaced Apache HttpClient with Jetty diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/DeviceListModel.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/DeviceListModel.java index 6bb35276b..4c3fc1ca1 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/DeviceListModel.java +++ b/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: * *
+ * {@code
  * 
  * 
@@ -73,8 +74,8 @@ import javax.xml.bind.annotation.XmlType;
  * 
  * 
  * 
- *
- * 
+ * }
+ * 
* * @author Robert Bausdorf - Initial contribution * @author Christoph Weitkamp - Added support for groups diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/HeatingModel.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/HeatingModel.java index 471798f7b..8c0e48086 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/HeatingModel.java +++ b/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 - * 16 <= 8°C, 17 = 8.5°C...... 56 >= 28°C, 254 = ON, 253 = OFF + * Valid celsius values: 8 to 28 °C > 16 to 56, + * 16 <= 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 diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/FritzAhaWebInterface.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/FritzAhaWebInterface.java index a8ebfe3bb..9369ea671 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/FritzAhaWebInterface.java +++ b/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) { diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/util/HeritableFuture.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/util/HeritableFuture.java index bb4a66e95..83ad4e96e 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/util/HeritableFuture.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/util/HeritableFuture.java @@ -57,7 +57,7 @@ public class HeritableFuture extends CompletableFuture { * * {@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 extends CompletableFuture { * * {@inheritDoc} * - * @implSpec + * @implNote * This implementation cancels this future first, then cancels the parent future. */ @Override @@ -107,7 +107,7 @@ public class HeritableFuture extends CompletableFuture { * * {@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 extends CompletableFuture { * * {@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 extends CompletableFuture { * * {@inheritDoc} * - * @implSpec + * @implNote * This implementation will treat the future returned by the function as a parent future. */ @Override diff --git a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BPUPListener.java b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BPUPListener.java index 72ea73b14..6420772ee 100644 --- a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BPUPListener.java +++ b/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..."); diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java index 999069962..88a26ef9d 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java +++ b/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 - * {@link org.eclipse.jetty.http.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 diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoDeviceController.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoDeviceController.java index 18afdf0e4..7100d4dfe 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoDeviceController.java +++ b/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 diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoTypeDatabase.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoTypeDatabase.java index ccb5648e1..00b709724 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoTypeDatabase.java +++ b/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 + * https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego * * @param toolTypeNumber condensed tool type number, e.g. "3600HA2200" rather than "3 600 HA2 200". * @return tool type name diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCHandler.java index 3298af12f..13aca7021 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCHandler.java +++ b/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 - * {@link #registerService(TService, Consumer, Collection, boolean)}. + * Initializes this handler. */ @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 diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/bridge/BoschHttpClient.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/bridge/BoschHttpClient.java index f3704c586..2e9e61246 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/bridge/BoschHttpClient.java +++ b/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 diff --git a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/BoseSoundTouchBindingConstants.java b/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/BoseSoundTouchBindingConstants.java index e9081abf8..6691a801a 100644 --- a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/BoseSoundTouchBindingConstants.java +++ b/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 diff --git a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/CommandExecutor.java b/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/CommandExecutor.java index 66707ccc2..9c87aca35 100644 --- a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/CommandExecutor.java +++ b/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 containing the items currently stored on the player + * @param playerPresets a {@code Map} containing the items currently stored on the player */ public void updatePresetContainerFromPlayer(Map playerPresets) { playerPresets.forEach((k, v) -> { diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountHandler.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountHandler.java index 4fc099dc1..36a913add 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountHandler.java +++ b/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 getPlants() throws SmartherGatewayException; diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/model/ModuleSettings.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/model/ModuleSettings.java index 9fe98faaa..248eb7cde 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/model/ModuleSettings.java +++ b/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) diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/DateUtil.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/DateUtil.java index 8dc7b2040..0d0706c26 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/DateUtil.java +++ b/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); diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinBindingConstants.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinBindingConstants.java index c4dc931ca..7eddfeaa6 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinBindingConstants.java +++ b/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 - Initial contribution - * @author Paul Smedley - Modifications to support Airbase Controllers + * @author Tim Waterhouse - Initial contribution + * @author Paul Smedley - Modifications to support Airbase Controllers */ @NonNullByDefault public class DaikinBindingConstants { diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinCommunicationException.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinCommunicationException.java index adcec52d9..6a0e3fe81 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinCommunicationException.java +++ b/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 - Initial contribution + * @author Tim Waterhouse - Initial contribution * */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinHandlerFactory.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinHandlerFactory.java index f91ceb044..bc390a8d7 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinHandlerFactory.java +++ b/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 - Initial contribution - * @author Paul Smedley - Modifications to support Airbase Controllers + * @author Tim Waterhouse - Initial contribution + * @author Paul Smedley - Modifications to support Airbase Controllers * */ @Component(service = ThingHandlerFactory.class, configurationPid = "binding.daikin") diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinWebTargets.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinWebTargets.java index 38c61ce7c..b29d43863 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/DaikinWebTargets.java +++ b/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 - 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 * diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/ControlInfo.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/ControlInfo.java index b12c1706c..40b8faebb 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/ControlInfo.java +++ b/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 - mods for Daikin Airbase + * @author Paul Smedley - mods for Daikin Airbase * */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/Enums.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/Enums.java index 07bd1026d..a88880e50 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/Enums.java +++ b/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 - Initial contribution + * @author Tim Waterhouse - Initial contribution * @author Lukas Agethen - Add special modes * */ diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseControlInfo.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseControlInfo.java index 4f87ac8ee..5caec9d7c 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseControlInfo.java +++ b/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 - Mods for Daikin Airbase Units + * @author Paul Smedley - Mods for Daikin Airbase Units * */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseEnums.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseEnums.java index dc0ee79d4..7ddfae0e4 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/api/airbase/AirbaseEnums.java +++ b/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 - Initial contribution - * @author Paul Smedley - Mods for Daikin Airbase Units + * @author Tim Waterhouse - Initial contribution + * @author Paul Smedley - Mods for Daikin Airbase Units * */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/discovery/DaikinACUnitDiscoveryService.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/discovery/DaikinACUnitDiscoveryService.java index 1554cf3b8..08f7d3c54 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/discovery/DaikinACUnitDiscoveryService.java +++ b/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 - Initial contribution - * @author Paul Smedley - Modifications to support Airbase Controllers + * @author Tim Waterhouse - Initial contribution + * @author Paul Smedley - Modifications to support Airbase Controllers * */ @Component(service = DiscoveryService.class, configurationPid = "discovery.daikin") diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAcUnitHandler.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAcUnitHandler.java index ed23fbfdd..72d9669e0 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAcUnitHandler.java +++ b/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 diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAirbaseUnitHandler.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAirbaseUnitHandler.java index f61d6f132..0f58c65db 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinAirbaseUnitHandler.java +++ b/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 - Modifications to support Airbase Controllers + * @author Paul Smedley - Modifications to support Airbase Controllers * @author Jimmy Tanagra - Support Airside and auto fan levels, DynamicStateDescription * */ diff --git a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinBaseHandler.java b/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinBaseHandler.java index 7ebc6050f..4006d8def 100644 --- a/bundles/org.openhab.binding.daikin/src/main/java/org/openhab/binding/daikin/internal/handler/DaikinBaseHandler.java +++ b/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 - Modifications to support Airbase Controllers + * @author Paul Smedley - Modifications to support Airbase Controllers * @author Jimmy Tanagra - Split handler classes, support Airside and DynamicStateDescription * */ diff --git a/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/dto/BridgeFullState.java b/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/dto/BridgeFullState.java index 536dfe0a7..655d746d7 100644 --- a/bundles/org.openhab.binding.deconz/src/main/java/org/openhab/binding/deconz/internal/dto/BridgeFullState.java +++ b/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/ + * {@code GET /api/} * * @author David Graeff - Initial contribution */ diff --git a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/DeletedSourceList.java b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/DeletedSourceList.java index 2eefa5f4c..937946932 100644 --- a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/DeletedSourceList.java +++ b/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 items of the CommandRX. + * Used to unmarshall {@code } items of the {@code } CommandRX. * * @author Jan-Willem Veldhuis - Initial contribution */ diff --git a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/RenameSourceList.java b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/RenameSourceList.java index bf060b784..7a274edf4 100644 --- a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/xml/entities/commands/RenameSourceList.java +++ b/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 items of the CommandRX. + * Used to unmarshall {@code } items of the {@code } CommandRX. * * @author Jan-Willem Veldhuis - Initial contribution */ diff --git a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/TripLabelAttribute.java b/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/TripLabelAttribute.java index 2f3671cbb..b4c118527 100644 --- a/bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/TripLabelAttribute.java +++ b/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 DB API - * Marketplace + * See DB API + * Marketplace * * @author Sönke Küper - Initial contribution. * diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/connector/DSMRSerialSettings.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/connector/DSMRSerialSettings.java index f75e36f05..22b33f137 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/connector/DSMRSerialSettings.java +++ b/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 ( ) + * This class can also convert a string setting + * ({@code }) * 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 diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemObjectType.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemObjectType.java index 46cd50601..0aab75694 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/cosem/CosemObjectType.java +++ b/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. diff --git a/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugBridgeConfiguration.java b/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugBridgeConfiguration.java index 90a98b5be..c755fb51d 100644 --- a/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugBridgeConfiguration.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchConnector.java b/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchConnector.java index 589959caa..80b1acc0b 100644 --- a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchConnector.java +++ b/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 - Initial contribution + * @author Sebastian Held - Initial contribution * @since 1.5.0 */ diff --git a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchException.java b/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchException.java index 84304f77a..4089bd3d4 100644 --- a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchException.java +++ b/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 - Initial contribution + * @author Sebastian Held - Initial contribution * @since 3.1.0 */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchTags.java b/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchTags.java index 288fb6a3b..382bb2756 100644 --- a/bundles/org.openhab.binding.ecotouch/src/main/java/org/openhab/binding/ecotouch/internal/EcoTouchTags.java +++ b/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 - Initial contribution + * @author Sebastian Held - Initial contribution * @since 1.5.0 */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.ekey/src/main/java/org/openhab/binding/ekey/internal/api/EkeyUdpPacketReceiver.java b/bundles/org.openhab.binding.ekey/src/main/java/org/openhab/binding/ekey/internal/api/EkeyUdpPacketReceiver.java index 6e1fe8862..e8b6ad093 100644 --- a/bundles/org.openhab.binding.ekey/src/main/java/org/openhab/binding/ekey/internal/api/EkeyUdpPacketReceiver.java +++ b/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 stopListener() + * This will run in a thread and can be interrupted by calling stopListener() * Before starting the thread initialization is required (mode, ip, port and deliminator) * * @author Hans-Jörg Merk - Initial contribution diff --git a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeType.java b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeType.java index 19d242b74..11aab0cb6 100644 --- a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeType.java +++ b/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 + * https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info * @author Jacob Laursen - Initial contribution */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeTypeCode.java b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeTypeCode.java index b9228a172..fc2564318 100644 --- a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/ChargeTypeCode.java +++ b/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 + * https://www.energidataservice.dk/tso-electricity/DatahubPricelist#metadata-info * @author Jacob Laursen - Initial contribution */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/GlobalLocationNumber.java b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/GlobalLocationNumber.java index 4baa897b0..e03e79aa9 100644 --- a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/api/GlobalLocationNumber.java +++ b/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 Global Location Number (GLN) + * can be used by companies to identify their locations. * * @author Jacob Laursen - Initial contribution */ diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/discovery/EnOceanUsbSerialDiscoveryParticipant.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/discovery/EnOceanUsbSerialDiscoveryParticipant.java index 337e4f7df..a1b78eea5 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/discovery/EnOceanUsbSerialDiscoveryParticipant.java +++ b/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}. - *

+ *

* Currently, this {@link UsbSerialDiscoveryParticipant} supports the Enocean USB300 dongles. * * @author Aitor Iturrioz - initial contribution diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/handler/EnOceanBridgeHandler.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/handler/EnOceanBridgeHandler.java index a49358733..d87d4385f 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/handler/EnOceanBridgeHandler.java +++ b/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 - * {@link org.openhab.binding.enocean.internal.handler.EnOceanActuatorHandler} and - * transferring received ESP3Packages to - * {@link org.openhab.binding.enocean.internal.handler.EnOceanSensorHandler}. + * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by {@link EnOceanBaseActuatorHandler} + * and transferring received ESP3Packages to {@link EnOceanBaseSensorHandler}. * * @author Daniel Weber - Initial contribution */ diff --git a/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/response/BatteryStatus.java b/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/response/BatteryStatus.java index d3879d291..433565a29 100644 --- a/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/response/BatteryStatus.java +++ b/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 } diff --git a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/AbstractWeatherHandler.java b/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/AbstractWeatherHandler.java index ce28d1f07..e2b7882d9 100644 --- a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/AbstractWeatherHandler.java +++ b/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 > void updateEpochSecondStateIfLinked(ChannelUID channelUID, long epochSecond) { if (isLinked(channelUID)) { diff --git a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/client/Client.java b/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/client/Client.java index 589e5db03..78029d66f 100644 --- a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/client/Client.java +++ b/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 * + *

* Subject to license terms https://en.ilmatieteenlaitos.fi/open-data * - * - * All weather stations: - * https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations&networkid=121& - * Networkid parameter isexplained in entries of - * https://opendata.fmi.fi/wfs/fin?service=WFS&version=2.0.0&request=GetFeature&storedquery_id=fmi::ef::stations + * @see + * All weather stations + * @see + * Networkid parameter is explained in entries of * * @author Sami Salonen - Initial contribution * diff --git a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/CitiesOfFinland.java b/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/CitiesOfFinland.java index 164b57b20..9ddaa8fb2 100644 --- a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/CitiesOfFinland.java +++ b/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) - * https://opendata.fmi.fi/wfs?service=WFS&version=2.0.0&request=getFeature&storedquery_id=fmi::forecast::hirlam::surface::cities::multipointcoverage - * + * Originally parsed from + * (not available any more) * * Using piece of code similar to below: * diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/FroniusBindingConstants.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/FroniusBindingConstants.java index fdcf16aeb..d307ba0e1 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/FroniusBindingConstants.java +++ b/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 diff --git a/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioApiResult.java b/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioApiResult.java index 0299f705a..2cf532a64 100644 --- a/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioApiResult.java +++ b/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: * *

+ * {@code
  * 
  *   <fsapiResponse> <status>FS_OK</status> <value><u8>1</u8></value> </fsapiResponse>
  * 
+ * }
  * 
* * This class parses this XML data and provides functions for reading and casting typical fields. diff --git a/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/GardenaSmartWebSocketListener.java b/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/GardenaSmartWebSocketListener.java index 36ceb1ce2..4a57e55d6 100644 --- a/bundles/org.openhab.binding.gardena/src/main/java/org/openhab/binding/gardena/internal/GardenaSmartWebSocketListener.java +++ b/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); diff --git a/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/GreeBindingConstants.java b/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/GreeBindingConstants.java index 0fdbc6c74..d5332baad 100644 --- a/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/GreeBindingConstants.java +++ b/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 + * https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor * for more details. */ public static final double INTERNAL_TEMP_SENSOR_OFFSET = -40.0; diff --git a/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/handler/GreeAirDevice.java b/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/handler/GreeAirDevice.java index 22bdec057..5cab3b6eb 100644 --- a/bundles/org.openhab.binding.gree/src/main/java/org/openhab/binding/gree/internal/handler/GreeAirDevice.java +++ b/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 diff --git a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/exceptions/HubShadeTimeoutException.java b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/exceptions/HubShadeTimeoutException.java index c6445e063..c11f9cc6a 100644 --- a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/exceptions/HubShadeTimeoutException.java +++ b/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 { diff --git a/bundles/org.openhab.binding.heliosventilation/src/main/java/org/openhab/binding/heliosventilation/internal/HeliosVentilationDataPoint.java b/bundles/org.openhab.binding.heliosventilation/src/main/java/org/openhab/binding/heliosventilation/internal/HeliosVentilationDataPoint.java index 6f1446097..7a2bc6e65 100644 --- a/bundles/org.openhab.binding.heliosventilation/src/main/java/org/openhab/binding/heliosventilation/internal/HeliosVentilationDataPoint.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/api/HeosFacade.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/api/HeosFacade.java index 68a257816..d21b8c4de 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/api/HeosFacade.java +++ b/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 diff --git a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java index 83b378f4b..0749695a4 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/Telnet.java +++ b/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); diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/common/HomematicConfig.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/common/HomematicConfig.java index d405f734b..a1e51083e 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/common/HomematicConfig.java +++ b/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()) { diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicConfigDescriptionProvider.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicConfigDescriptionProvider.java index 3d9086eb0..fbea32af2 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicConfigDescriptionProvider.java +++ b/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. thing-type:homematic:HM-WDS40-TH-I-2 * @return ConfigDescription that was added to HomematicConfigDescriptionProvider, * identified by its config-description-uri
diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicThingTypeProvider.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicThingTypeProvider.java index 1a01f6fba..bde962995 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicThingTypeProvider.java +++ b/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. homematic:HM-Sec-SC diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/Resource.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/Resource.java index 44ef31e88..c9e214608 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/Resource.java +++ b/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. * diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/ResourceReference.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/ResourceReference.java index bc44ea190..f8baf1c0f 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/ResourceReference.java +++ b/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/ endpoint, but all those resources commonly reference each other, which is done in a + * {@code /resource/} 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 diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/helper/Setters.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/helper/Setters.java index 8fef7cff8..17dc1b6d2 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/dto/clip2/helper/Setters.java +++ b/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 (but it can also handle DecimalType). + * @param command the new state command should be a {@code QuantityType} (but it can also handle + * {@code DecimalType}). * @param source another resource containing the MirekSchema. * * @return the target resource. diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2ThingHandler.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2ThingHandler.java index 76d7b4c5c..356d9d8ce 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/Clip2ThingHandler.java +++ b/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 allScenes) + * Fetch the full list of scenes from the bridge, and call {@code updateSceneContributors(List allScenes)} * * @throws ApiException if a communication error occurred. * @throws AssetNotLoadedException if one of the assets is not loaded. diff --git a/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/api/IAqualinkClient.java b/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/api/IAqualinkClient.java index 5176b9cda..daf280ca8 100644 --- a/bundles/org.openhab.binding.iaqualink/src/main/java/org/openhab/binding/iaqualink/internal/api/IAqualinkClient.java +++ b/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 sessionId - * @param auxId - * @param lightValue + * @param serial + * @param sessionID + * @param auxID + * @param level * @return * @throws IOException * @throws NotAuthorizedException diff --git a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/AbstractPresentableCalendar.java b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/AbstractPresentableCalendar.java index 4e4fa4833..a401547e6 100644 --- a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/AbstractPresentableCalendar.java +++ b/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 diff --git a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTag.java b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTag.java index 01c7191b3..240b78331 100644 --- a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTag.java +++ b/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.. * + *
+ * {@code
  * BEGIN::
  * BEGIN:::
  * END::
  * END:::
+ * }
+ * 
* * @author Andrew Fiddian-Green - Initial contribution */ diff --git a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java b/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java index 21f1432e6..aef55cf71 100644 --- a/bundles/org.openhab.binding.icalendar/src/main/java/org/openhab/binding/icalendar/internal/logic/CommandTagType.java +++ b/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: * + *
+ * {@code
  * BEGIN::
  * END::
+ * }
+ * 
* * @author Andrew Fiddian-Green - Initial contribution */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/Converter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/Converter.java index 15c165ab8..6b2ddd17d 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/Converter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/ConverterFactory.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/ConverterFactory.java index 48fc72e19..1a5efc17f 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/ConverterFactory.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSDateValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSDateValueConverter.java index 17b38de48..0e4ef1314 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSDateValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSTimeValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSTimeValueConverter.java index ab5464fc5..0f742fb41 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DateTimeTypeWSTimeValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSBooleanValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSBooleanValueConverter.java index 6170e3ad7..f07237a25 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSBooleanValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSEnumValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSEnumValueConverter.java index 522629145..d8398bcb7 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSEnumValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSFloatingPointValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSFloatingPointValueConverter.java index e556b44bb..70027ab69 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSFloatingPointValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSIntegerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSIntegerValueConverter.java index eadfddd1b..955766568 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSIntegerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSTimerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSTimerValueConverter.java index a2957fc11..7f9e3c1b5 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSTimerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSWeekdayValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSWeekdayValueConverter.java index 29d963516..ce9d4069a 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/DecimalTypeWSWeekdayValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSBooleanValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSBooleanValueConverter.java index 41c37cd92..8a09be0a7 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSBooleanValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSIntegerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSIntegerValueConverter.java index 4bed06b0c..02258531d 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OnOffTypeWSIntegerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSBooleanValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSBooleanValueConverter.java index d99389e9e..dc2bf5322 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSBooleanValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSIntegerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSIntegerValueConverter.java index 37e2abd64..51a070769 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/OpenClosedTypeWSIntegerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/PercentTypeWSIntegerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/PercentTypeWSIntegerValueConverter.java index f5468cfbd..5af7bc8b7 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/PercentTypeWSIntegerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/StringTypeWSEnumValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/StringTypeWSEnumValueConverter.java index 655b36a30..972509e7c 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/StringTypeWSEnumValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSBooleanValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSBooleanValueConverter.java index 75cbf4ce0..67e870d29 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSBooleanValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSIntegerValueConverter.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSIntegerValueConverter.java index 6a0f4e61a..9002d59e6 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/converters/UpDownTypeWSIntegerValueConverter.java +++ b/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 */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/services/IhcResourceInteractionService.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/services/IhcResourceInteractionService.java index aa2536afa..1fef8ec24 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/services/IhcResourceInteractionService.java +++ b/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 waitResourceValueNotifications(int timeoutInSeconds) throws IhcExecption { diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonAddress.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonAddress.java index 8808869f1..4407ecfc1 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonAddress.java +++ b/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; diff --git a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/enums/IntesisHomeModeEnum.java b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/enums/IntesisHomeModeEnum.java index 216306380..22bb65ae2 100644 --- a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/enums/IntesisHomeModeEnum.java +++ b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/enums/IntesisHomeModeEnum.java @@ -15,7 +15,7 @@ package org.openhab.binding.intesis.internal.enums; import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link IntesisModeEnum) contains informations for translating device modes into internally used numbers. + * The {@link IntesisHomeModeEnum} contains informations for translating device modes into internally used numbers. * * @author Hans-Jörg Merk - Initial contribution */ diff --git a/bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/discovery/KaleidescapeDiscoveryService.java b/bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/discovery/KaleidescapeDiscoveryService.java index 97883a2b0..9c3cd77a4 100644 --- a/bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/discovery/KaleidescapeDiscoveryService.java +++ b/bundles/org.openhab.binding.kaleidescape/src/main/java/org/openhab/binding/kaleidescape/internal/discovery/KaleidescapeDiscoveryService.java @@ -158,7 +158,7 @@ public class KaleidescapeDiscoveryService extends AbstractDiscoveryService { * {@inheritDoc} * * Stops the discovery scan. We set {@link #scanning} to false (allowing the listening thread to end naturally - * within {@link #TIMEOUT) * 5 time then shutdown the {@link #executorService} + * within {@link #DISCOVERY_DEFAULT_TIMEOUT_RATE_MS} * 5 time then shutdown the {@link #ExecutorService} */ @Override protected synchronized void stopScan() { diff --git a/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/handler/KM200SwitchProgramServiceHandler.java b/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/handler/KM200SwitchProgramServiceHandler.java index a72c6c3b1..2bd07f6c7 100644 --- a/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/handler/KM200SwitchProgramServiceHandler.java +++ b/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/handler/KM200SwitchProgramServiceHandler.java @@ -34,7 +34,7 @@ import com.google.gson.JsonObject; * The KM200SwitchProgramService representing a switch program service with its all capabilities * * @author Markus Eckhardt - Initial contribution - * @NonNullByDefault is not working here because of the switchMap array handling + * @implNote {@code @NonNullByDefault} is not working here because of the switchMap array handling */ public class KM200SwitchProgramServiceHandler { diff --git a/bundles/org.openhab.binding.knx/pom.xml b/bundles/org.openhab.binding.knx/pom.xml index 2b959aa0a..b4b14a04a 100644 --- a/bundles/org.openhab.binding.knx/pom.xml +++ b/bundles/org.openhab.binding.knx/pom.xml @@ -71,24 +71,6 @@ SPI-Consumer: java.util.ServiceLoader#load(java.lang.Class[tuwien.auto.calimero. - - org.apache.maven.plugins - maven-javadoc-plugin - - - - apiNote - a - API note: - - - implNote - a - Implementation note: - - - - diff --git a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/KodiBindingConstants.java b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/KodiBindingConstants.java index 0f5de787c..949db0e15 100644 --- a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/KodiBindingConstants.java +++ b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/KodiBindingConstants.java @@ -23,7 +23,7 @@ import org.openhab.core.thing.ThingTypeUID; * * @author Paul Frank - Initial contribution * @author Christoph Weitkamp - Added channels for opening PVR TV or Radio streams - * @author Andreas Reinhardt & Christoph Weitkamp - Added channels for thumbnail and fanart + * @author Andreas Reinhardt and Christoph Weitkamp - Added channels for thumbnail and fanart * @author Christoph Weitkamp - Improvements for playing audio notifications */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/handler/KodiHandler.java b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/handler/KodiHandler.java index be5f908ce..89d26c575 100644 --- a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/handler/KodiHandler.java +++ b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/handler/KodiHandler.java @@ -73,7 +73,7 @@ import org.slf4j.LoggerFactory; * * @author Paul Frank - Initial contribution * @author Christoph Weitkamp - Added channels for opening PVR TV or Radio streams - * @author Andreas Reinhardt & Christoph Weitkamp - Added channels for thumbnail and fanart + * @author Andreas Reinhardt and Christoph Weitkamp - Added channels for thumbnail and fanart * @author Christoph Weitkamp - Improvements for playing audio notifications * @author Meng Yiqi - Added selection of audio and subtitle */ diff --git a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/protocol/KodiConnection.java b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/protocol/KodiConnection.java index e92930512..cb8f7dd3e 100644 --- a/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/protocol/KodiConnection.java +++ b/bundles/org.openhab.binding.kodi/src/main/java/org/openhab/binding/kodi/internal/protocol/KodiConnection.java @@ -58,7 +58,7 @@ import com.google.gson.JsonSyntaxException; * * @author Paul Frank - Initial contribution * @author Christoph Weitkamp - Added channels for opening PVR TV or Radio streams - * @author Andreas Reinhardt & Christoph Weitkamp - Added channels for thumbnail and fanart + * @author Andreas Reinhardt and Christoph Weitkamp - Added channels for thumbnail and fanart * @author Christoph Weitkamp - Improvements for playing audio notifications */ public class KodiConnection implements KodiClientSocketEventListener { diff --git a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/handler/KonnectedHandler.java b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/handler/KonnectedHandler.java index 05627ea75..d3f347a41 100644 --- a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/handler/KonnectedHandler.java +++ b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/handler/KonnectedHandler.java @@ -104,8 +104,8 @@ public class KonnectedHandler extends BaseThingHandler { } /** - * Process a {@link WebHookEvent} that has been received by the Servlet from a Konnected module with respect to a - * sensor event or status update request + * Process a {@link KonnectedModuleGson} that has been received by the Servlet from a Konnected module with respect + * to a sensor event or status update request * * @param event the {@link KonnectedModuleGson} event that contains the state and pin information to be processed */ diff --git a/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/api/common/impl/typeadapters/imported/RuntimeTypeAdapterFactory.java b/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/api/common/impl/typeadapters/imported/RuntimeTypeAdapterFactory.java index c76c32a5a..6619a10df 100644 --- a/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/api/common/impl/typeadapters/imported/RuntimeTypeAdapterFactory.java +++ b/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/api/common/impl/typeadapters/imported/RuntimeTypeAdapterFactory.java @@ -129,7 +129,7 @@ import com.google.gson.stream.MalformedJsonException; *
  * {
  *     @code
- *     RuntimeTypeAdapterFactory shapeAdapterFactory = RuntimeTypeAdapterFactory.of(Shape.class, "type");
+ *     RuntimeTypeAdapterFactory<Shape> shapeAdapterFactory = RuntimeTypeAdapterFactory.of(Shape.class, "type");
  * }
  * 
* @@ -159,7 +159,7 @@ import com.google.gson.stream.MalformedJsonException; *
  * {
  *     @code
- *     RuntimeTypeAdapterFactory shapeAdapterFactory = RuntimeTypeAdapterFactory.of(Shape.class)
+ *     RuntimeTypeAdapterFactory<Shape> shapeAdapterFactory = RuntimeTypeAdapterFactory.of(Shape.class)
  *             .registerSubtype(Rectangle.class).registerSubtype(Circle.class).registerSubtype(Diamond.class);
  * }
  * 
diff --git a/bundles/org.openhab.binding.lghombot/src/main/java/org/openhab/binding/lghombot/internal/discovery/LGHomBotDiscovery.java b/bundles/org.openhab.binding.lghombot/src/main/java/org/openhab/binding/lghombot/internal/discovery/LGHomBotDiscovery.java index 59ab1bef0..acedf9ac4 100644 --- a/bundles/org.openhab.binding.lghombot/src/main/java/org/openhab/binding/lghombot/internal/discovery/LGHomBotDiscovery.java +++ b/bundles/org.openhab.binding.lghombot/src/main/java/org/openhab/binding/lghombot/internal/discovery/LGHomBotDiscovery.java @@ -268,7 +268,7 @@ public class LGHomBotDiscovery extends AbstractDiscoveryService { * {@inheritDoc} * * Stops the discovery scan. We set {@link #scanning} to false (allowing the listening threads to end naturally - * within {@link #TIMEOUT_MS) * {@link #SCAN_THREADS} time then shutdown the {@link #executorService} + * within {@link #TIMEOUT_MS} * {@link #SCAN_THREADS} time then shutdown the {@link #executorService} */ @Override protected synchronized void stopScan() { diff --git a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxProduct.java b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxProduct.java index 3c2643369..d60e03e5e 100644 --- a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxProduct.java +++ b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxProduct.java @@ -26,7 +26,8 @@ import org.openhab.core.thing.ThingTypeUID; /** * Enumerates the LIFX products, their IDs and feature set. * - * @see https://lan.developer.lifx.com/docs/lifx-products + * @see + * https://lan.developer.lifx.com/docs/lifx-products * * @author Wouter Born - Initial contribution * @author Wouter Born - Add temperature ranges and simplify feature definitions diff --git a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/dto/SignalStrength.java b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/dto/SignalStrength.java index c7b585888..e92679f39 100644 --- a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/dto/SignalStrength.java +++ b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/dto/SignalStrength.java @@ -37,9 +37,9 @@ public class SignalStrength { /** * Returns the signal strength as a quality percentage: *
    - *
  • RSSI <= -100: returns 0 - *
  • -100 < RSSI < -50: returns a value between 0 and 1 (linearly distributed) - *
  • RSSI >= -50: returns 1 + *
  • {@code RSSI <= -100}: returns 0 + *
  • {@code -100 < RSSI < -50}: returns a value between 0 and 1 (linearly distributed) + *
  • {@code RSSI >= -50}: returns 1 *
* * @return a value between 0 and 1. 0 being worst strength and 1 @@ -62,7 +62,7 @@ public class SignalStrength { /** * Returns the received signal strength indicator (RSSI). * - * @return a value <= 0. 0 being best strength and more negative values indicate worser strength. + * @return a value {@code <= 0. 0} being best strength and more negative values indicate worser strength. */ public double toRSSI() { return 10 * Math.log10(milliWatts); diff --git a/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/handler/LivisiBridgeHandler.java b/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/handler/LivisiBridgeHandler.java index 462370c7f..58864e357 100644 --- a/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/handler/LivisiBridgeHandler.java +++ b/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/handler/LivisiBridgeHandler.java @@ -84,10 +84,10 @@ import org.slf4j.LoggerFactory; /** * The {@link LivisiBridgeHandler} is responsible for handling the LIVISI SmartHome controller including the connection * to the LIVISI SmartHome backend for all communications with the LIVISI SmartHome {@link DeviceDTO}s. - *

+ *

* It implements the {@link AccessTokenRefreshListener} to handle updates of the oauth2 tokens and the * {@link EventListener} to handle {@link EventDTO}s, that are received by the {@link LivisiWebSocket}. - *

+ *

* The {@link DeviceDTO}s are organized by the {@link DeviceStructureManager}, which is also responsible for the * connection * to the LIVISI SmartHome webservice via the {@link LivisiClient}. diff --git a/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/listener/EventListener.java b/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/listener/EventListener.java index 20d08c370..2658afa4e 100644 --- a/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/listener/EventListener.java +++ b/bundles/org.openhab.binding.livisismarthome/src/main/java/org/openhab/binding/livisismarthome/internal/listener/EventListener.java @@ -40,7 +40,7 @@ public interface EventListener { void onError(Throwable cause); /** - * This method is called, when the evenRunner stops abnormally (statuscode <> 1000). + * This method is called, when the evenRunner stops abnormally ({@code statuscode <> 1000}). */ void connectionClosed(); } diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/CcoHandler.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/CcoHandler.java index a7848d365..06410f992 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/CcoHandler.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/handler/CcoHandler.java @@ -37,9 +37,9 @@ import org.slf4j.LoggerFactory; * Handler responsible for communicating with Lutron contact closure outputs (CCOs). * e.g. VCRX CCOs and CCO RF module * - * Note: For a RA2 Pulsed CCO, querying the output state with ?OUTPUT,,1 is meaningless and will always - * return 100 (on). Also, the main repeater will not report ~OUTPUT commands for a pulsed CCO regardless of - * the #MONITORING setting. So this binding supports sending pulses ONLY. + * Note: For a RA2 Pulsed CCO, querying the output state with {@code ?OUTPUT,,1} is meaningless and will + * always return 100 (on). Also, the main repeater will not report ~OUTPUT commands for a pulsed CCO regardless + * of the #MONITORING setting. So this binding supports sending pulses ONLY. * * @author Bob Adair - Initial contribution * diff --git a/bundles/org.openhab.binding.luxtronikheatpump/src/main/java/org/openhab/binding/luxtronikheatpump/internal/discovery/LuxtronikHeatpumpDiscovery.java b/bundles/org.openhab.binding.luxtronikheatpump/src/main/java/org/openhab/binding/luxtronikheatpump/internal/discovery/LuxtronikHeatpumpDiscovery.java index e5084dffd..3549f9cfb 100644 --- a/bundles/org.openhab.binding.luxtronikheatpump/src/main/java/org/openhab/binding/luxtronikheatpump/internal/discovery/LuxtronikHeatpumpDiscovery.java +++ b/bundles/org.openhab.binding.luxtronikheatpump/src/main/java/org/openhab/binding/luxtronikheatpump/internal/discovery/LuxtronikHeatpumpDiscovery.java @@ -213,7 +213,7 @@ public class LuxtronikHeatpumpDiscovery extends AbstractDiscoveryService { * {@inheritDoc} * * Stops the discovery scan. We set {@link #scanning} to false (allowing the listening threads to end naturally - * within {@link #TIMEOUT_MS) * {@link #SCAN_THREADS} time then shutdown the {@link #executorService} + * within {@link #TIMEOUT_MS} * {@link #SCAN_THREADS} time then shutdown the {@link #executorService} */ @Override protected synchronized void stopScan() { diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVControl.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVControl.java index c47d0b979..8f1f25c38 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVControl.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVControl.java @@ -102,7 +102,11 @@ public class MagentaTVControl { * Retries the device properties. This will result in an Exception if the device * is not connected. * + *

* Response is returned in XMl format, e.g.: + * + *

+ * {@code * * 10 * uuid:70dff25c-1bdf-5731-a283-XXXXXXXX @@ -115,6 +119,7 @@ public class MagentaTVControl { * urn:dial-multiscreen-org:service:dial:1 * urn:dial-multiscreen-org:service:dial * + * } * * @return true: device is online, false: device is offline * @throws MagentaTVException @@ -171,9 +176,11 @@ public class MagentaTVControl { * Subscripbe to event channel a) receive the pairing code b) receive * programInfo and playStatus events after successful paring * + * {@code * SUBSCRIBE /upnp/service/X-CTC_RemotePairing/Event HTTP/1.1\r\n HOST: * $remote_ip:$remote_port CALLBACK: \r\n // NT: * upnp:event\r\n // TIMEOUT: Second-300\r\n // CONNECTION: close\r\n // \r\n + * } * * @throws MagentaTVException */ @@ -208,9 +215,14 @@ public class MagentaTVControl { /** * Send Pairing Request to the Media Receiver. The method waits for the * response, but the pairing code will be received via the NOTIFY callback (see - * NotifyServlet) + * NotifyServlet). * - * XML format for Pairing Request: + * XML format for Pairing Request: + * + *

+ * {@code + * \n * $pairingDeviceID\n * $friendlyName\n $userID\n * \n - * + * } + * * @return true: pairing successful * @throws MagentaTVException */ @@ -251,7 +264,7 @@ public class MagentaTVControl { /** * Calculates the verifificationCode to complete pairing. This will be triggered * as a result after receiving the pairing code provided by the MR. The - * verification code is the MD5 hash of + * verification code is the MD5 hash of {@code } * * @param pairingCode Pairing code received from the MR * @return true: a new code has been generated, false: the code matches a @@ -333,8 +346,11 @@ public class MagentaTVControl { * code (0x.... notation) or with a symbolic namne, which will first be mapped * to the key code * - * XML format for Send Key + *

+ * XML format for Send Key: * + *

+ * {@code * \n * 0\n * keyCode=$keyCode^$pairingDeviceID:$verificationCode^userID:$userID\n * \n + * } * * @param keyName * @return true: successful, false: failed, e.g. unkown key code @@ -498,9 +515,9 @@ public class MagentaTVControl { /** * Helper to parse a Xml tag value from string without using a complex XML class * - * @param xml Input string in the format value + * @param xml Input string in the format {@code value} * @param tagName The tag to find - * @return Tag value (between and ) + * @return Tag value (between {@code } and {@code }) */ public static String getXmlValue(String xml, String tagName) { String open = "<" + tagName + ">"; diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNotifyServlet.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNotifyServlet.java index acdb48409..8d3bdbd37 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNotifyServlet.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNotifyServlet.java @@ -68,23 +68,34 @@ public class MagentaTVNotifyServlet extends HttpServlet { /** * Notify servlet handler (will be called by jetty * + *

* Format of SOAP message: + * + *

+ * {@code * * 1C18548DAF7DE9BC231249DB28D2A650 * X-pairingCheck:5218C0AA * + * } * - * Format of event message: + *

+ * Format of event message: {@code } + * + *

+ * {@code * * AC6FBB61B1E5 * {"new_play_mode":0,"playBackState":1,& * quot;mediaType":1,"mediaCode":"3682"} + * } * * @param request * @param response * - * @throws ServletException, IOException + * @throws ServletException + * @throws IOException */ @Override protected void service(@Nullable HttpServletRequest request, @Nullable HttpServletResponse response) diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java index 38c42b842..c35225384 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/Utils.java @@ -19,7 +19,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** * Utility class for common tasks within the MAX! binding package. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update * */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/MCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/MCommand.java index 45dc66d9b..c476a88e9 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/MCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/MCommand.java @@ -30,7 +30,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The {@link MCommand} Creates the MAX! Cube the room & device name information update message. + * The {@link MCommand} Creates the MAX! Cube the room and device name information update message. * * @author Marcel Verpaalen - Initial Contribution */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/SCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/SCommand.java index 62812ba3c..8f5185902 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/SCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/SCommand.java @@ -19,9 +19,9 @@ import org.openhab.binding.max.internal.Utils; import org.openhab.binding.max.internal.device.ThermostatModeType; /** - * {@link SCommand} for setting MAX! thermostat temperature & mode. + * {@link SCommand} for setting MAX! thermostat temperature and mode. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update + simplification */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/config/MaxCubeBridgeConfiguration.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/config/MaxCubeBridgeConfiguration.java index 8d9579a50..7f18eb534 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/config/MaxCubeBridgeConfiguration.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/config/MaxCubeBridgeConfiguration.java @@ -27,7 +27,8 @@ public class MaxCubeBridgeConfiguration { /** * The port of the MAX! Cube LAN gateway as provided at - * http://www.elv.de/controller.aspx?cid=824&detail=10&detail2=3484 + * + * http://www.elv.de/controller.aspx?cid=824&detail=10&detail2=3484 */ public Integer port; diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/Device.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/Device.java index 1ff5ee389..70242098c 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/Device.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/Device.java @@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory; /** * Base class for devices provided by the MAX! protocol. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update + enhancements */ public abstract class Device { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceConfiguration.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceConfiguration.java index b5b5cb82c..eff0f9879 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceConfiguration.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceConfiguration.java @@ -21,7 +21,7 @@ import org.openhab.binding.max.internal.message.Message; /** * Base class for configuration provided by the MAX! Cube C Message. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ public final class DeviceConfiguration { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceInformation.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceInformation.java index e6fc4eaa2..b97d081a1 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceInformation.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceInformation.java @@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device; /** * Device information provided by the M message meta information. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ public class DeviceInformation { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceType.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceType.java index 1e4455893..b65021685 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceType.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/DeviceType.java @@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device; /** * This enumeration represents the different message types provided by the MAX! Cube protocol. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ public enum DeviceType { Invalid(256), diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/HeatingThermostat.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/HeatingThermostat.java index 0a6644cc4..d7c9d4fe9 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/HeatingThermostat.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/HeatingThermostat.java @@ -18,9 +18,9 @@ import java.util.Calendar; import java.util.Date; /** - * MAX! Heating thermostat & Heating thermostat+ . + * MAX! Heating thermostat and Heating thermostat+ . * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update */ public class HeatingThermostat extends Device { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/RoomInformation.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/RoomInformation.java index 83f681875..818ea8d97 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/RoomInformation.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/RoomInformation.java @@ -15,8 +15,8 @@ package org.openhab.binding.max.internal.device; /** * Room information provided by the M message meta information. * - * @author Andreas Heil (info@aheil.de) - Initial contribution - * @author Marcel Verpaalen (marcel@verpaalen.com) - OH2 update + * @author Andreas Heil - Initial contribution + * @author Marcel Verpaalen - OH2 update */ public class RoomInformation { private int position; diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ShutterContact.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ShutterContact.java index 12d7cb059..bb793b6e3 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ShutterContact.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ShutterContact.java @@ -17,7 +17,7 @@ import org.openhab.core.library.types.OpenClosedType; /** * MAX! Shutter contact device. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update */ public class ShutterContact extends Device { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ThermostatModeType.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ThermostatModeType.java index 20733d5f2..0522e4317 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ThermostatModeType.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/ThermostatModeType.java @@ -19,7 +19,7 @@ import org.openhab.core.types.State; /** * This enumeration represents the different mode types of a MAX! heating thermostat. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update */ public enum ThermostatModeType implements PrimitiveType, State, Command { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/UnsupportedDevice.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/UnsupportedDevice.java index b74dd3d5c..c110d423b 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/UnsupportedDevice.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/UnsupportedDevice.java @@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device; /** * Unsupported devices. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/WallMountedThermostat.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/WallMountedThermostat.java index 096cc3c98..a946adc76 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/WallMountedThermostat.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/device/WallMountedThermostat.java @@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device; /** * MAX! wall mounted thermostat. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ public class WallMountedThermostat extends HeatingThermostat { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncompleteMessageException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncompleteMessageException.java index c313a6447..2e7c714b1 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncompleteMessageException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncompleteMessageException.java @@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions; * Will be thrown when there is an attempt to put a new message line into the message processor, * but the processor is currently processing another message type. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class IncompleteMessageException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncorrectMultilineIndexException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncorrectMultilineIndexException.java index 3b3ff6314..ddefb08a5 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncorrectMultilineIndexException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/IncorrectMultilineIndexException.java @@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions; * Will be thrown when there is an attempt to put a new message line into the message processor, * but the processor is currently processing another message type. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class IncorrectMultilineIndexException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/MessageIsWaitingException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/MessageIsWaitingException.java index ec5b87ed2..f0c0ad1bc 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/MessageIsWaitingException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/MessageIsWaitingException.java @@ -17,7 +17,7 @@ package org.openhab.binding.max.internal.exceptions; * but the processor is not yet ready to handle new lines because there is already a message that * has be pulled before. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class MessageIsWaitingException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/NoMessageAvailableException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/NoMessageAvailableException.java index 5c4070ab1..32c7d1370 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/NoMessageAvailableException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/NoMessageAvailableException.java @@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions; * Will be thrown when there is an attempt to pull a message from the message processor, * but the processor does not yet have a complete message. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class NoMessageAvailableException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnprocessableMessageException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnprocessableMessageException.java index 4f0aa263f..390105755 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnprocessableMessageException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnprocessableMessageException.java @@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions; * Will be thrown when there is an attempt to put a new message line into the message processor, * the processor detects a known message indicator, but the message could not be parsed correctly. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class UnprocessableMessageException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnsupportedMessageTypeException.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnsupportedMessageTypeException.java index 5988cece8..2a14f7357 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnsupportedMessageTypeException.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/exceptions/UnsupportedMessageTypeException.java @@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions; * Will be thrown when there is an attempt to put a new message line into the message processor, * but the line starts with an unknown message indicator. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ public class UnsupportedMessageTypeException extends Exception { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxCubeBridgeHandler.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxCubeBridgeHandler.java index a3fdbff33..83a4e5d94 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxCubeBridgeHandler.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxCubeBridgeHandler.java @@ -105,7 +105,7 @@ import org.slf4j.LoggerFactory; * to the framework. All {@link MaxDevicesHandler}s use the * {@link MaxCubeBridgeHandler} to execute the actual commands. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - Initial contribution OH2 version * @author Bernd Michael Helm (bernd.helm at helmundwalter.de) - Exclusive mode */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/CMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/CMessage.java index 927ca59d2..98fa645a7 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/CMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/CMessage.java @@ -35,7 +35,7 @@ import org.slf4j.LoggerFactory; /** * The {@link CMessage} contains configuration about a MAX! device. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - Detailed parsing, OH2 Update */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/HMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/HMessage.java index 53ca7ab5a..92dd9fff5 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/HMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/HMessage.java @@ -25,7 +25,7 @@ import org.slf4j.Logger; /** * The H message contains information about the MAX! Cube. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - Details parsing, OH2 version */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/LMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/LMessage.java index ca7e2d184..5b3e4774c 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/LMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/LMessage.java @@ -27,7 +27,7 @@ import org.slf4j.Logger; /** * The L message contains real time information about all MAX! devices. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 update * */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MMessage.java index b7a8f45df..45e001911 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MMessage.java @@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory; /** * The M message contains metadata about the MAX! Cube setup. * - * @author Andreas Heil (info@aheil.de) - Initial Contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - Room details parse */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MaxTokenizer.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MaxTokenizer.java index 2474d08ee..f645367f7 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MaxTokenizer.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MaxTokenizer.java @@ -24,7 +24,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; * The tokens returned consist of the payload solely, and do not contain the first byte holding the * tokens length. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ @NonNullByDefault public final class MaxTokenizer implements Enumeration { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/Message.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/Message.java index 578b8c963..33debb8f7 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/Message.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/Message.java @@ -18,7 +18,7 @@ import org.slf4j.Logger; /** * Base message for the messages received from the MAX! Cube. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ @NonNullByDefault public abstract class Message { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageProcessor.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageProcessor.java index 222add76d..ab989b230 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageProcessor.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageProcessor.java @@ -33,7 +33,7 @@ import org.openhab.binding.max.internal.exceptions.UnsupportedMessageTypeExcepti * possible to add additional lines when there is a message ready to be * processed. * - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ @NonNullByDefault public class MessageProcessor { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageType.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageType.java index 3b0cb9ffb..c2377fe9c 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageType.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/MessageType.java @@ -17,7 +17,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** * This enumeration represents the different message types provided by the MAX! Cube protocol. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution */ @NonNullByDefault public enum MessageType { diff --git a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/CMessageTest.java b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/CMessageTest.java index afd436979..27fb64536 100644 --- a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/CMessageTest.java +++ b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/CMessageTest.java @@ -21,7 +21,7 @@ import org.openhab.binding.max.internal.device.DeviceType; /** * Tests cases for {@link CMessage}. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 Version and updates */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/ConfigurationTest.java b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/ConfigurationTest.java index 4c0c1c8bf..ca861c84d 100644 --- a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/ConfigurationTest.java +++ b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/ConfigurationTest.java @@ -24,7 +24,7 @@ import org.openhab.binding.max.internal.device.DeviceType; /** * Tests cases for {@link DeviceConfiguration}. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 Version and updates */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/MessageProcessorTest.java b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/MessageProcessorTest.java index 53191630a..bafc6b27f 100644 --- a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/MessageProcessorTest.java +++ b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/MessageProcessorTest.java @@ -24,7 +24,7 @@ import org.openhab.binding.max.internal.exceptions.UnprocessableMessageException import org.openhab.binding.max.internal.exceptions.UnsupportedMessageTypeException; /** - * @author Christian Rockrohr - Initial contribution + * @author Christian Rockrohr - Initial contribution */ @NonNullByDefault public class MessageProcessorTest { diff --git a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/UtilsTest.java b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/UtilsTest.java index 39150a9a7..9dd92a65a 100644 --- a/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/UtilsTest.java +++ b/bundles/org.openhab.binding.max/src/test/java/org/openhab/binding/max/internal/message/UtilsTest.java @@ -23,7 +23,7 @@ import org.openhab.binding.max.internal.Utils; /** * Tests cases for {@link Utils}. * - * @author Andreas Heil (info@aheil.de) - Initial contribution + * @author Andreas Heil - Initial contribution * @author Marcel Verpaalen - OH2 Version and updates */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.mcd/src/main/java/org/openhab/binding/mcd/internal/handler/McdBridgeHandler.java b/bundles/org.openhab.binding.mcd/src/main/java/org/openhab/binding/mcd/internal/handler/McdBridgeHandler.java index 98f2e6cdd..882a51be7 100644 --- a/bundles/org.openhab.binding.mcd/src/main/java/org/openhab/binding/mcd/internal/handler/McdBridgeHandler.java +++ b/bundles/org.openhab.binding.mcd/src/main/java/org/openhab/binding/mcd/internal/handler/McdBridgeHandler.java @@ -154,7 +154,7 @@ public class McdBridgeHandler extends BaseBridgeHandler { } /** - * Should be used by C&S binding's things to obtain the bridge's access token + * Should be used by C&S binding's things to obtain the bridge's access token * * @return returns the access token as String */ diff --git a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/MieleBindingConstants.java b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/MieleBindingConstants.java index e4af33ef4..09067a846 100644 --- a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/MieleBindingConstants.java +++ b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/MieleBindingConstants.java @@ -20,7 +20,7 @@ import org.openhab.core.thing.ThingTypeUID; * used across the whole binding. * * @author Karel Goderis - Initial contribution - * @author Martin Lepsy - added constants for support of WiFi devices & protocol + * @author Martin Lepsy - added constants for support of WiFi devices and protocol * @author Jacob Laursen - Fixed multicast and protocol support (ZigBee/LAN) */ @NonNullByDefault diff --git a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/MieleBridgeHandler.java b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/MieleBridgeHandler.java index 108a42398..4f2132d7e 100644 --- a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/MieleBridgeHandler.java +++ b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/MieleBridgeHandler.java @@ -74,7 +74,7 @@ import com.google.gson.JsonElement; * * @author Karel Goderis - Initial contribution * @author Kai Kreuzer - Fixed lifecycle issues - * @author Martin Lepsy - Added protocol information to support WiFi devices & some refactoring for HomeDevice + * @author Martin Lepsy - Added protocol information to support WiFi devices and some refactoring for HomeDevice * @author Jacob Laursen - Fixed multicast and protocol support (Zigbee/LAN) **/ @NonNullByDefault diff --git a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/EncryptionHelper.java b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/EncryptionHelper.java index d27cbb6ae..26456a00a 100644 --- a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/EncryptionHelper.java +++ b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/EncryptionHelper.java @@ -28,7 +28,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Encrypts communication between openhab & xiaomi bridge (required by xiaomi). + * Encrypts communication between openhab and xiaomi bridge (required by xiaomi). * * @author Ondřej Pečta - Initial contribution to Xiaomi MiHome Binding for OH 1.x * @author Dieter Schmidt - Refactor logger diff --git a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/ModelMapper.java b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/ModelMapper.java index 51b5315d7..c401e5ce2 100644 --- a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/ModelMapper.java +++ b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/ModelMapper.java @@ -25,7 +25,8 @@ import org.openhab.core.thing.ThingTypeUID; * @author Patrick Boos - Initial contribution * @author Kuba Wolanin - Renamed labels * @author Dieter Schmidt - Refactor - * @author Daniel Walters - Add Xiaomi Aqara Temperature, Humidity & Pressure sensor and Xiaomi Aqara Door/Window sensor + * @author Daniel Walters - Add Xiaomi Aqara Temperature, Humidity & Pressure sensor and Xiaomi Aqara Door/Window + * sensor */ public class ModelMapper { diff --git a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiActorGatewayHandler.java b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiActorGatewayHandler.java index 9cda485b1..c55508575 100644 --- a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiActorGatewayHandler.java +++ b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiActorGatewayHandler.java @@ -29,7 +29,7 @@ import com.google.gson.JsonObject; /** * @author Patrick Boos - Initial contribution - * @author Dieter Schmidt - Refactor & sound + * @author Dieter Schmidt - Refactor and sound */ public class XiaomiActorGatewayHandler extends XiaomiActorBaseHandler { diff --git a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiSensorHtHandler.java b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiSensorHtHandler.java index 86429ed86..ae77d6a15 100644 --- a/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiSensorHtHandler.java +++ b/bundles/org.openhab.binding.mihome/src/main/java/org/openhab/binding/mihome/internal/handler/XiaomiSensorHtHandler.java @@ -20,7 +20,7 @@ import org.openhab.core.thing.Thing; import com.google.gson.JsonObject; /** - * Handles the Xiaomi temperature & humidity sensor + * Handles the Xiaomi temperature & humidity sensor * * @author Patrick Boos - Initial contribution * @author Daniel Walters - Add pressure support diff --git a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/protocol/MilightV6SessionManager.java b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/protocol/MilightV6SessionManager.java index 13d1e06b1..fe3f274fd 100644 --- a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/protocol/MilightV6SessionManager.java +++ b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/protocol/MilightV6SessionManager.java @@ -367,6 +367,9 @@ public class MilightV6SessionManager implements Runnable, Closeable { * The session ID, password and sequence number is automatically inserted from this object. * * Produces data like: + * + *

+     * {@code
      * SN: Sequence number
      * S1: SessionID1
      * S2: SessionID2
@@ -376,13 +379,15 @@ public class MilightV6SessionManager implements Runnable, Closeable {
      * CK: Checksum
      *
      * #zone 1 on
-     * @ 80 00 00 00 11 84 00 00 0c 00 31 00 00 08 04 01 00 00 00 01 00 3f
+     * @ 80 00 00 00 11 84 00 00 0c 00 31 00 00 08 04 01 00 00 00 01 00 3f
      *
      * Colors:
      * CC: Color value (hue)
      * 80 00 00 00 11 S1 S2 SN SN 00 31 P1 P2 WB 01 CC CC CC CC ZN 00 CK
      *
      * 80 00 00 00 11 D4 00 00 12 00 31 00 00 08 01 FF FF FF FF 01 00 38
+     * }
+     * 
* * @return */ diff --git a/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/dto/EmergencyBlock.java b/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/dto/EmergencyBlock.java index 3216858c9..4d10f1b3e 100644 --- a/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/dto/EmergencyBlock.java +++ b/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/dto/EmergencyBlock.java @@ -49,7 +49,7 @@ public class EmergencyBlock implements Data { EP_POSSIBLE, EP_SWITCH }; /** - * For decoding see Modbus Register Mapping Chapter 3.1.2 page 14 & 15 + * For decoding see Modbus Register Mapping Chapter 3.1.2 page 14 & 15 * * @param bArray - Modbus Registers as bytes from 40084 to 40085 */ diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/AtomicStampedValue.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/AtomicStampedValue.java index 4805c1885..98099e668 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/AtomicStampedValue.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/AtomicStampedValue.java @@ -66,7 +66,6 @@ public class AtomicStampedValue implements Cloneable { * Copy data atomically and return the new (shallow) copy * * @return new copy of the data - * @throws CloneNotSupportedException */ @SuppressWarnings("unchecked") public synchronized AtomicStampedValue copy() { diff --git a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/mapping/AbstractMqttAttributeClass.java b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/mapping/AbstractMqttAttributeClass.java index b19641893..2915f4d31 100644 --- a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/mapping/AbstractMqttAttributeClass.java +++ b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/mapping/AbstractMqttAttributeClass.java @@ -272,11 +272,13 @@ public abstract class AbstractMqttAttributeClass implements SubscribeFieldToMQTT *

* *
+     * {@code
      * void attributeChanged(..., boolean allMandatoryFieldsReceived) {
      *   if (allMandatoryFieldsReceived && !attributes.isComplete()) {
      *      // The attribute class is now complete but wasn't before...
      *   }
      * }
+     * }
      * 
*/ public boolean isComplete() { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/MyBMWConstants.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/MyBMWConstants.java index 3f1e741a4..db452ace1 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/MyBMWConstants.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/MyBMWConstants.java @@ -22,7 +22,7 @@ import org.openhab.core.thing.ThingTypeUID; * used across the whole binding. * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ @NonNullByDefault public class MyBMWConstants { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/ChargeProfile.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/ChargeProfile.java index c8f78dd9a..37b033d17 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/ChargeProfile.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/ChargeProfile.java @@ -18,7 +18,7 @@ import java.util.List; * The {@link ChargeProfile} Data Transfer Object * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ public class ChargeProfile { public static final Timer INVALID_TIMER = new Timer(); diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Time.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Time.java index 6bc212fc6..283c43fce 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Time.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Time.java @@ -18,7 +18,7 @@ import org.openhab.binding.mybmw.internal.utils.Converter; * The {@link Time} Data Transfer Object * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ public class Time { public int hour;// ": 11, diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Timer.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Timer.java index 92a1c0994..c610a79c5 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Timer.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/dto/charge/Timer.java @@ -20,7 +20,7 @@ import org.openhab.binding.mybmw.internal.utils.Constants; * The {@link Timer} Data Transfer Object * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ public class Timer { public int id = -1;// ": 1, diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/MyBMWProxy.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/MyBMWProxy.java index 6dd9a8531..8a82eb18c 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/MyBMWProxy.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/MyBMWProxy.java @@ -57,14 +57,15 @@ import org.slf4j.LoggerFactory; /** * The {@link MyBMWProxy} This class holds the important constants for the BMW Connected Drive Authorization. - * They - * are taken from the Bimmercode from github {@link https://github.com/bimmerconnected/bimmer_connected} + * They are taken from the Bimmercode from github + * https://github.com/bimmerconnected/bimmer_connected. * File defining these constants - * {@link https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/account.py} - * https://customer.bmwgroup.com/one/app/oauth.js + * + * https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/account.py + * https://customer.bmwgroup.com/one/app/oauth.js * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ @NonNullByDefault public class MyBMWProxy { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/RemoteServiceHandler.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/RemoteServiceHandler.java index 3fd881c10..b40e480ac 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/RemoteServiceHandler.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/RemoteServiceHandler.java @@ -38,10 +38,11 @@ import com.google.gson.JsonSyntaxException; /** * The {@link RemoteServiceHandler} handles executions of remote services towards your Vehicle * - * @see https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/remote_services.py + * @see + * https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/remote_services.py * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ @NonNullByDefault public class RemoteServiceHandler implements StringResponseCallback { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleChannelHandler.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleChannelHandler.java index 740be7a24..396815bfb 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleChannelHandler.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleChannelHandler.java @@ -71,7 +71,7 @@ import org.slf4j.LoggerFactory; * The {@link VehicleChannelHandler} handles Channel updates * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send of charge profile + * @author Norbert Truchsess - edit and send of charge profile */ @NonNullByDefault public abstract class VehicleChannelHandler extends BaseThingHandler { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleHandler.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleHandler.java index cc38f261d..78c104068 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleHandler.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/handler/VehicleHandler.java @@ -49,7 +49,7 @@ import com.google.gson.JsonSyntaxException; * The {@link VehicleHandler} handles responses from BMW API * * @author Bernd Weymann - Initial contribution - * @author Norbert Truchsess - edit & send charge profile + * @author Norbert Truchsess - edit and send charge profile */ @NonNullByDefault public class VehicleHandler extends VehicleChannelHandler { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/BimmerConstants.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/BimmerConstants.java index 0ae620e26..7284c6411 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/BimmerConstants.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/BimmerConstants.java @@ -19,10 +19,12 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** * The {@link BimmerConstants} This class holds the important constants for the BMW Connected Drive Authorization. They - * are taken from the Bimmercode from github {@link https://github.com/bimmerconnected/bimmer_connected} + * are taken from the Bimmercode from github + * https://github.com/bimmerconnected/bimmer_connected. * File defining these constants - * {@link https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/account.py} - * https://customer.bmwgroup.com/one/app/oauth.js + * + * https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/account.py + * https://customer.bmwgroup.com/one/app/oauth.js * * @author Bernd Weymann - Initial contribution */ diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/PubSubAPI.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/PubSubAPI.java index 08e61bdfe..05c1ab0e5 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/PubSubAPI.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/PubSubAPI.java @@ -57,8 +57,10 @@ import org.slf4j.LoggerFactory; * * @author Wouter Born - Initial contribution * - * @see https://cloud.google.com/pubsub/docs/reference/rest - * @see https://developers.google.com/nest/device-access/api/events + * @see + * https://cloud.google.com/pubsub/docs/reference/rest + * @see + * https://developers.google.com/nest/device-access/api/events */ @NonNullByDefault public class PubSubAPI { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/SDMAPI.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/SDMAPI.java index 46deb27c9..ac2911196 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/SDMAPI.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/api/SDMAPI.java @@ -61,7 +61,8 @@ import org.slf4j.LoggerFactory; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest + * @see + * https://developers.google.com/nest/device-access/reference/rest */ @NonNullByDefault public class SDMAPI { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/discovery/SDMDiscoveryService.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/discovery/SDMDiscoveryService.java index fab8d5573..0bffe3aeb 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/discovery/SDMDiscoveryService.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/discovery/SDMDiscoveryService.java @@ -44,7 +44,8 @@ import org.slf4j.LoggerFactory; * @author Brian Higginbotham - Initial contribution * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/list + * @see + * https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/list */ @NonNullByDefault public class SDMDiscoveryService extends AbstractDiscoveryService implements ThingHandlerService { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/PubSubRequestsResponses.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/PubSubRequestsResponses.java index 5b577e341..a0c51ddd0 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/PubSubRequestsResponses.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/PubSubRequestsResponses.java @@ -21,7 +21,8 @@ import java.util.List; * * @author Wouter Born - Initial contribution * - * @see https://cloud.google.com/pubsub/docs/reference/rest + * @see + * https://cloud.google.com/pubsub/docs/reference/rest */ public class PubSubRequestsResponses { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMCommands.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMCommands.java index 48becd653..f9f2c80aa 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMCommands.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMCommands.java @@ -30,7 +30,8 @@ import org.openhab.binding.nest.internal.sdm.dto.SDMTraits.SDMThermostatMode; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/executeCommand + * @see + * https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/executeCommand */ public class SDMCommands { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMError.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMError.java index a69d9c4f3..af725f01c 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMError.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMError.java @@ -17,7 +17,8 @@ package org.openhab.binding.nest.internal.sdm.dto; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/errors/api + * @see + * https://developers.google.com/nest/device-access/reference/errors/api */ public class SDMError { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMEvent.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMEvent.java index db3360587..76e8d00c6 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMEvent.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMEvent.java @@ -27,7 +27,8 @@ import com.google.gson.annotations.SerializedName; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/api/events + * @see + * https://developers.google.com/nest/device-access/api/events */ public class SDMEvent { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListDevicesResponse.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListDevicesResponse.java index 37e1618aa..04ae34161 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListDevicesResponse.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListDevicesResponse.java @@ -21,7 +21,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/list + * @see + * https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.devices/list */ @NonNullByDefault public class SDMListDevicesResponse { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListRoomsResponse.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListRoomsResponse.java index 94ecb2eb2..0e5d55076 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListRoomsResponse.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListRoomsResponse.java @@ -21,7 +21,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.structures.rooms/list + * @see + * https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.structures.rooms/list */ @NonNullByDefault public class SDMListRoomsResponse { diff --git a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListStructuresResponse.java b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListStructuresResponse.java index 8997fef62..2e53244de 100644 --- a/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListStructuresResponse.java +++ b/bundles/org.openhab.binding.nest/src/main/java/org/openhab/binding/nest/internal/sdm/dto/SDMListStructuresResponse.java @@ -21,7 +21,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; * * @author Wouter Born - Initial contribution * - * @see https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.structures/list + * @see + * https://developers.google.com/nest/device-access/reference/rest/v1/enterprises.structures/list */ @NonNullByDefault public class SDMListStructuresResponse { diff --git a/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/PresenceDetection.java b/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/PresenceDetection.java index 1ec2845c7..65cd686a7 100644 --- a/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/PresenceDetection.java +++ b/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/PresenceDetection.java @@ -236,7 +236,7 @@ public class PresenceDetection implements IPRequestReceivedCallback { } /** - * Return the last seen value in milliseconds based on {@link System.currentTimeMillis()} or 0 if not seen yet. + * Return the last seen value in milliseconds based on {@link System#currentTimeMillis()} or 0 if not seen yet. */ public long getLastSeen() { return lastSeenInMS; diff --git a/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/toberemoved/cache/ExpiringCacheAsync.java b/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/toberemoved/cache/ExpiringCacheAsync.java index 2f038e70d..e8b42eab4 100644 --- a/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/toberemoved/cache/ExpiringCacheAsync.java +++ b/bundles/org.openhab.binding.network/src/main/java/org/openhab/binding/network/internal/toberemoved/cache/ExpiringCacheAsync.java @@ -51,7 +51,7 @@ public class ExpiringCacheAsync { * * @param expiry the duration in milliseconds for how long the value stays valid. Must be greater than 0. * @param cacheUpdater The cache will use this callback if a new value is needed. Must not be null. - * @throws IllegalArgumentException For an expire value <=0 or a null cacheUpdater. + * @throws IllegalArgumentException For an expire value {@literal <=0} or a null cacheUpdater. */ public ExpiringCacheAsync(long expiry, @Nullable ExpiringCacheUpdate cacheUpdater) throws IllegalArgumentException { if (expiry <= 0) { diff --git a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/callback/AbstractUplinkCommandCallback.java b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/callback/AbstractUplinkCommandCallback.java index 7e84dc05c..fc16862f2 100644 --- a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/callback/AbstractUplinkCommandCallback.java +++ b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/callback/AbstractUplinkCommandCallback.java @@ -135,7 +135,7 @@ public abstract class AbstractUplinkCommandCallback extends BufferingResponseLis } /** - * @Nullable wrapper of gson which does not 'understand' nonnull annotations + * {@code @Nullable} wrapper of gson which does not 'understand' nonnull annotations * * @param json * @return diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostat.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostat.java index 9312d8fd4..cd21399e3 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostat.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostat.java @@ -73,7 +73,7 @@ public abstract class NhcThermostat { * @param overrule the overrule temperature in 0.1°C multiples * @param overruletime in minutes * @param ecosave - * @param demand 0 if no demand, > 0 if heating, < 0 if cooling + * @param demand 0 if no demand, > 0 if heating, < 0 if cooling */ public void updateState(int measured, int setpoint, int mode, int overrule, int overruletime, int ecosave, int demand) { diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostatEvent.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostatEvent.java index 75a38212d..67ea98e40 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostatEvent.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcThermostatEvent.java @@ -33,7 +33,7 @@ public interface NhcThermostatEvent { * @param setpoint the setpoint temperature in 0.1°C multiples * @param mode thermostat mode 0 = day, 1 = night, 2 = eco, 3 = off, 4 = cool, 5 = prog1, 6 = prog2, 7 = prog3 * @param overrule the overrule temperature in 0.1°C multiples - * @param demand 0 if no demand, > 0 if heating, < 0 if cooling + * @param demand 0 if no demand, > 0 if heating, < 0 if cooling */ void thermostatEvent(int measured, int setpoint, int mode, int overrule, int demand); diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/discovery/OwDiscoveryItem.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/discovery/OwDiscoveryItem.java index bb2c8196e..de6551f49 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/discovery/OwDiscoveryItem.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/discovery/OwDiscoveryItem.java @@ -146,7 +146,7 @@ public class OwDiscoveryItem { } /** - * get Label " ()" + * get Label {@code " ()"} * * @return the thing label */ diff --git a/bundles/org.openhab.binding.opengarage/src/main/java/org/openhab/binding/opengarage/internal/api/Enums.java b/bundles/org.openhab.binding.opengarage/src/main/java/org/openhab/binding/opengarage/internal/api/Enums.java index 80d991a9e..1a7e1c359 100644 --- a/bundles/org.openhab.binding.opengarage/src/main/java/org/openhab/binding/opengarage/internal/api/Enums.java +++ b/bundles/org.openhab.binding.opengarage/src/main/java/org/openhab/binding/opengarage/internal/api/Enums.java @@ -18,7 +18,7 @@ import org.slf4j.LoggerFactory; /** * Container class for enums related to opengarage * - * @author Paul Smedley - Initial contribution + * @author Paul Smedley - Initial contribution * */ public class Enums { diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java index bce904a0e..42df1e5b6 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java @@ -190,14 +190,14 @@ public interface OpenSprinklerApi { /** * Returns a list of all internal programs as a list of StateOptions. * - * @return List + * @return {@code List} */ List getPrograms(); /** * Return a list of all the stations the device has as List of StateOptions * - * @return List + * @return {@code List} */ List getStations(); @@ -212,7 +212,7 @@ public interface OpenSprinklerApi { void runProgram(Command command) throws CommunicationApiException, UnauthorizedApiException; /** - * Fetch the station names and place them in a list of List. + * Fetch the station names and place them in a list of {@code List}. * Use getStations() to retrieve this list. * * @throws CommunicationApiException @@ -250,7 +250,7 @@ public interface OpenSprinklerApi { /** * Gets the rain delay in hours from the OpenSprinkler device. * - * @return QuantityType