From db12f77d0f56c735320393f936260941c85308ce Mon Sep 17 00:00:00 2001 From: Holger Friedrich Date: Wed, 13 Sep 2023 17:41:02 +0200 Subject: [PATCH 1/3] Improve javadoc Fix broken references, syntax errors. Signed-off-by: Holger Friedrich --- .../JRubyScriptEngineConfiguration.java | 2 +- .../AbstractScriptExtensionProvider.java | 1 - ...tDisposalAwareScriptExtensionProvider.java | 1 - .../internal/hub/AdorneHubChangeNotify.java | 2 +- .../binding/airq/internal/AirqHandler.java | 2 +- .../internal/AirQualityBindingConstants.java | 2 +- .../internal/protocol/ADCommand.java | 2 +- .../internal/AllPlayBindingConstants.java | 2 +- .../capturing/PacketCapturingHandler.java | 2 +- .../internal/handler/EchoHandler.java | 1 - .../googletv/GoogleTVConnectionManager.java | 1 - .../internal/handler/AnthemCommand.java | 2 +- .../astro/internal/AstroBindingConstants.java | 2 +- .../internal/handler/AstroThingHandler.java | 2 - .../internal/api/AsuswrtHttpClient.java | 4 +- .../internal/helpers/AsuswrtErrorHandler.java | 4 +- .../internal/structures/AsuswrtIpInfo.java | 2 +- .../internal/things/AsuswrtRouter.java | 2 +- .../internal/AtlonaBindingConstants.java | 2 +- .../internal/AtlonaHandlerCallback.java | 14 ++-- .../internal/pro3/AtlonaPro3Config.java | 3 +- .../internal/pro3/AtlonaPro3Handler.java | 3 +- .../internal/AutelisBindingConstants.java | 2 +- .../internal/AutomowerBindingConstants.java | 2 +- .../api/automowerconnect/dto/Calendar.java | 2 +- .../api/automowerconnect/dto/Planner.java | 2 +- .../internal/things/AutomowerHandler.java | 2 +- .../internal/dto/ColorControlModel.java | 2 +- .../dto/templates/ApplyMaskListModel.java | 2 +- .../dto/templates/DeviceListModel.java | 2 +- .../FritzAhaSetLevelPercentageCallback.java | 2 +- .../handler/BenqProjectorHandler.java | 2 +- .../internal/AirthingsConfiguration.java | 2 +- .../bluegiga/BlueGigaBluetoothDevice.java | 4 +- .../handler/BlueGigaBridgeHandler.java | 1 - .../internal/BlueGigaTransactionManager.java | 3 +- .../bluegiga/internal/eir/EirDataType.java | 2 +- .../bluegiga/internal/eir/EirFlags.java | 2 +- .../bluez/internal/BlueZBluetoothDevice.java | 1 - .../bluetooth/gattserial/MessageHandler.java | 5 +- .../internal/RadoneyeConfiguration.java | 2 +- .../bluetooth/BaseBluetoothDevice.java | 4 +- .../bluetooth/BluetoothCharacteristic.java | 4 +- .../binding/bluetooth/BluetoothDevice.java | 6 +- .../internal/BluetoothDeviceSnapshot.java | 12 ++-- .../internal/BluetoothDiscoveryProcess.java | 2 +- .../BluetoothScanNotification.java | 2 +- .../bondhome/internal/api/BPUPListener.java | 2 +- .../bondhome/internal/api/BondHttpApi.java | 2 +- .../config/BondDeviceConfiguration.java | 2 +- .../internal/handler/BondBridgeHandler.java | 2 +- .../internal/AuthorizationListener.java | 6 +- .../internal/BoschIndegoBindingConstants.java | 2 +- .../internal/IndegoController.java | 3 +- .../response/runtime/DeviceStateRuntimes.java | 3 +- .../internal/devices/BoschSHCHandler.java | 2 +- .../devices/bridge/BoschHttpClient.java | 2 +- .../childlock/dto/ChildLockServiceState.java | 4 +- .../dto/PowerMeterServiceState.java | 2 +- .../BoseSoundTouchBindingConstants.java | 2 +- .../internal/CommandExecutor.java | 2 +- .../internal/PresetContainer.java | 2 - .../discovery/BroadlinkDiscoveryService.java | 1 - .../handler/FloureonThermostatHandler.java | 1 - .../helper/BsbLanParameterConverter.java | 2 +- .../account/SmartherAccountHandler.java | 22 ++---- .../account/SmartherAccountService.java | 8 +-- .../account/SmartherNotificationHandler.java | 6 +- .../internal/api/SmartherApi.java | 24 +++---- .../internal/api/SmartherApiConnector.java | 3 +- .../internal/api/dto/Chronothermostat.java | 8 +-- .../internal/api/dto/Enums.java | 15 ++-- .../internal/api/dto/Measure.java | 8 +-- .../internal/api/dto/Sensor.java | 4 +- .../SmartherNotificationException.java | 2 +- .../internal/util/DateUtil.java | 21 ++---- .../internal/util/StringUtil.java | 6 +- .../caddx/internal/CaddxCommunicator.java | 2 +- .../handler/CaddxBaseThingHandler.java | 5 +- .../binding/cbus/CBusBindingConstants.java | 2 +- .../cm11a/internal/CM11ABindingConstants.java | 2 +- .../internal/ComfoAirCommandType.java | 2 +- .../internal/ComfoAirSerialConnector.java | 2 +- .../internal/ComfoAirSerialException.java | 2 +- .../internal/ControllerHandler.java | 2 +- .../CoronaStatsCountryConfiguration.java | 3 +- .../config/CoronaStatsWorldConfiguration.java | 3 +- .../handler/DaliDt8DeviceHandler.java | 2 - .../dbimpl/influx2/Influx2Database.java | 1 - .../DenonMarantzBindingConstants.java | 2 +- .../internal/TripLabelAttribute.java | 2 +- .../BridgeMDNSDiscoveryParticipant.java | 2 +- .../discovery/DeviceDiscoveryService.java | 8 ++- .../discovery/DiscoveryServiceManager.java | 5 +- .../discovery/SceneDiscoveryService.java | 3 +- ...oneTemperatureControlDiscoveryService.java | 6 +- .../impl/SensorValues.java | 3 +- .../impl/TemperatureControlConfig.java | 43 ++++++++---- .../impl/TemperatureControlValues.java | 4 +- .../impl/WeatherSensorData.java | 5 +- .../internal/lib/config/Config.java | 68 +++++++++++++------ .../internal/lib/event/EventHandler.java | 3 +- .../internal/lib/event/EventListener.java | 3 +- .../internal/lib/event/types/EventItem.java | 4 +- .../lib/listener/DeviceStatusListener.java | 23 ++++--- .../lib/listener/SceneStatusListener.java | 5 +- .../listener/SystemStateChangeListener.java | 4 +- .../lib/manager/DeviceStatusManager.java | 24 ++++--- .../internal/lib/manager/SceneManager.java | 17 +++-- .../manager/impl/StructureManagerImpl.java | 5 +- .../sensorjobexecutor/CircuitScheduler.java | 4 +- .../SceneReadingJobExecutor.java | 5 +- .../sensorjobexecutor/SensorJobExecutor.java | 11 +-- .../sensorjob/SensorJob.java | 9 ++- .../internal/lib/serverconnection/DsAPI.java | 15 ++-- .../impl/HttpTransportImpl.java | 4 +- .../SimpleRequestBuilder.java | 9 --- .../constants/ExeptionConstants.java | 6 +- .../AbstractGeneralDeviceInformations.java | 2 +- .../lib/structure/devices/Circuit.java | 5 +- .../lib/structure/devices/Device.java | 19 ++++-- .../devices/GeneralDeviceInformation.java | 2 +- .../deviceparameters/DeviceStateUpdate.java | 4 +- .../impl/DeviceBinaryInput.java | 12 ++-- .../impl/DeviceSensorValue.java | 10 +-- .../internal/lib/util/DSJsonParser.java | 3 +- .../providers/DsChannelTypeProvider.java | 10 +-- .../providers/DsDeviceThingTypeProvider.java | 3 +- .../dominoswiss/internal/EGateHandler.java | 3 +- .../internal/audio/ConvertedInputStream.java | 2 - .../config/ControllerConfiguration.java | 2 +- .../config/DoorbellConfiguration.java | 2 +- .../DraytonWiserMDNSDiscoveryParticipant.java | 1 - .../handler/DSCAlarmBaseThingHandler.java | 2 +- .../internal/device/DSMRTelegramListener.java | 2 - .../discovery/DSMRMeterDiscoveryService.java | 2 - .../DWDPollenflugRegionConfiguration.java | 2 +- .../internal/dto/DwdWarningCache.java | 5 +- .../command/AbstractWriteCommand.java | 2 - .../internal/connector/WebInterface.java | 2 - .../internal/api/impl/EcovacsXmppDevice.java | 1 - .../internal/api/ElectroluxDeltaAPI.java | 1 - ...EleroTransmitterStickBindingConstants.java | 2 +- .../internal/handler/EnergeniePWMHandler.java | 1 - .../internal/PriceListParser.java | 3 +- .../internal/retry/RetryPolicyFactory.java | 3 +- .../internal/EnOceanBindingConstants.java | 4 +- .../internal/EnOceanChannelDescription.java | 4 +- .../enocean/internal/eep/A5_09/A5_09.java | 1 - .../enocean/internal/eep/A5_09/A5_09_05.java | 1 - .../enocean/internal/eep/A5_09/A5_09_0C.java | 1 - .../enocean/internal/eep/A5_09/A5_09_0D.java | 1 - .../enocean/internal/eep/A5_10/A5_10.java | 2 - .../internal/eep/A5_38/A5_38_08_Dimming.java | 2 + .../enocean/internal/eep/EEPHelper.java | 1 - .../handler/EnOceanBridgeHandler.java | 6 +- .../internal/handler/BaseEvohomeHandler.java | 2 - .../internal/domain/Measurand.java | 1 - .../fliclib/javaclient/ButtonScanner.java | 3 +- .../fmiweather/internal/client/Client.java | 4 +- .../discovery/FMIWeatherDiscoveryService.java | 2 +- .../internal/FoldingBindingConstants.java | 2 +- .../internal/FoobotBindingConstants.java | 2 +- .../internal/FreeboxBindingConstants.java | 2 +- .../internal/FreeboxOsBindingConstants.java | 2 +- .../internal/api/FreeboxOsIconProvider.java | 2 +- .../internal/api/MeterRealtimeBodyDTO.java | 2 +- .../api/MeterRealtimeBodyDataDTO.java | 2 +- .../internal/api/MeterRealtimeDetailsDTO.java | 2 +- .../api/MeterRealtimeResponseDTO.java | 2 +- .../internal/api/OhmpilotRealtimeBodyDTO.java | 2 +- .../api/OhmpilotRealtimeBodyDataDTO.java | 2 +- .../api/OhmpilotRealtimeDetailsDTO.java | 2 +- .../api/OhmpilotRealtimeResponseDTO.java | 2 +- .../handler/FroniusBaseThingHandler.java | 1 - .../radio/FrontierSiliconRadioConnection.java | 9 +-- .../internal/FtpUploadBindingConstants.java | 2 +- .../internal/config/FtpUploadConfig.java | 2 +- .../internal/command/AbstractCommand.java | 2 - .../internal/discovery/MulticastListener.java | 1 - .../internal/api/GoEStatusResponseDTO.java | 2 +- .../gpio/internal/GPIOBindingConstants.java | 2 +- .../gpio/internal/GPIOHandlerFactory.java | 2 +- .../gree/internal/GreeBindingConstants.java | 2 +- .../gree/internal/handler/GreeAirDevice.java | 2 +- .../handler/GroheOndusSenseGuardHandler.java | 1 - .../bridge/GroupePSABridgeHandler.java | 2 +- .../internal/HarmonyHubBindingConstants.java | 2 +- ...aywardDynamicStateDescriptionProvider.java | 4 +- .../internal/HaywardThingHandler.java | 2 +- .../internal/HDanywhereBindingConstants.java | 2 +- .../internal/HDPowerViewBindingConstants.java | 2 +- .../internal/HeliosBindingConstants.java | 2 +- .../heos/internal/HeosBindingConstants.java | 2 +- .../binding/heos/internal/api/HeosFacade.java | 12 ++-- .../HeosStringPropertyChangeListener.java | 2 +- .../communicator/HomematicGateway.java | 7 +- .../converter/type/QuantityTypeConverter.java | 2 +- .../HomematicChannelGroupTypeProvider.java | 2 +- .../type/HomematicChannelTypeProvider.java | 3 +- .../HomematicConfigDescriptionProvider.java | 6 +- .../type/HomematicThingTypeExcluder.java | 2 + .../CascadedValueTransformationImpl.java | 4 +- .../transform/SingleValueTransformation.java | 2 +- .../hue/internal/connection/Clip2Bridge.java | 2 + .../HueBridgeMDNSDiscoveryParticipant.java | 2 +- .../discovery/HueDeviceDiscoveryService.java | 2 +- .../internal/handler/GroupStatusListener.java | 2 +- .../internal/handler/HueBridgeHandler.java | 1 - .../internal/handler/HueSensorHandler.java | 1 - .../internal/handler/LightStateConverter.java | 2 +- .../internal/HyperionBindingConstants.java | 2 +- .../internal/api/IAqualinkClient.java | 19 +++--- .../ihc/internal/config/IhcConfiguration.java | 2 +- .../binding/ihc/internal/ws/IhcClient.java | 3 +- .../ws/datatypes/WSNumberOfSegments.java | 2 +- .../ihc/internal/ws/datatypes/WSRFDevice.java | 4 +- .../internal/ws/datatypes/WSSystemInfo.java | 4 +- .../ihc/internal/ws/datatypes/WSUser.java | 6 -- .../IhcResourceInteractionService.java | 3 +- .../device/DeviceFeatureListener.java | 4 +- .../internal/device/InsteonDevice.java | 12 ++-- .../internal/device/MessageHandler.java | 2 +- .../binding/insteon/internal/message/Msg.java | 6 +- .../internal/api/IntesisHomeHttpApi.java | 2 +- .../internal/api/MessageReceivedEvent.java | 3 +- .../ism8/internal/Ism8BindingConstants.java | 2 +- .../ism8/internal/Ism8Configuration.java | 2 +- .../ism8/internal/Ism8HandlerFactory.java | 2 +- .../openhab/binding/ism8/server/Server.java | 2 +- .../dto/JuiceNetApiDeviceChargingStatus.java | 2 +- .../keba/internal/KebaBindingConstants.java | 2 +- .../km200/internal/KM200BindingConstants.java | 2 +- .../kodi/internal/KodiBindingConstants.java | 2 +- .../internal/KonnectedConfiguration.java | 7 +- .../internal/KonnectedHTTPUtils.java | 4 +- .../konnected/internal/ZoneConfiguration.java | 2 +- .../internal/handler/KonnectedHandler.java | 5 +- ...econdGenerationDxsEntriesContainerDTO.java | 2 +- .../LaMetricTimeBindingConstants.java | 2 +- .../lcn/internal/LcnModuleActions.java | 4 +- .../lcn/internal/LcnModuleHandler.java | 4 +- .../binding/lcn/internal/common/LcnAddr.java | 3 +- .../binding/lcn/internal/common/LcnDefs.java | 2 +- .../lcn/internal/common/PckGenerator.java | 10 +-- .../binding/lcn/internal/common/Variable.java | 3 +- .../lcn/internal/connection/Connection.java | 2 +- .../lcn/internal/converter/Converter.java | 2 +- .../internal/converter/ValueConverter.java | 2 +- .../AbstractLcnModuleSubHandler.java | 1 - .../internal/LgTvSerialBindingConstants.java | 2 +- .../lgwebos/internal/BaseChannelHandler.java | 3 +- .../lgwebos/internal/WakeOnLanUtility.java | 2 +- .../lifx/internal/LifxBindingConstants.java | 2 +- .../lifx/internal/dto/SignalStrength.java | 2 +- .../LifxPropertiesUpdateListener.java | 2 +- .../lirc/internal/LIRCBindingConstants.java | 2 +- .../lirc/internal/LIRCMessageListener.java | 2 +- .../lirc/internal/LIRCResponseException.java | 2 +- .../config/LIRCBridgeConfiguration.java | 2 +- .../config/LIRCRemoteConfiguration.java | 2 +- .../internal/connector/LIRCConnector.java | 2 +- .../internal/connector/LIRCEventListener.java | 4 +- .../internal/connector/LIRCStreamReader.java | 2 +- .../config/LogReaderConfiguration.java | 2 +- .../internal/LutronBindingConstants.java | 2 +- .../internal/grxprg/GrafikEyeConfig.java | 2 +- .../lutron/internal/hw/HwDimmerConfig.java | 2 +- .../internal/hw/HwSerialBridgeConfig.java | 2 +- .../internal/protocol/GroupCommand.java | 1 - .../internal/protocol/SysvarCommand.java | 1 - .../internal/protocol/TimeclockCommand.java | 1 - .../internal/MagentaTVHandlerFactory.java | 9 --- .../internal/handler/MagentaTVControl.java | 2 +- .../internal/handler/MagentaTVHandler.java | 8 ++- .../internal/network/MagentaTVHttp.java | 5 +- .../internal/network/MagentaTVNetwork.java | 4 +- .../network/MagentaTVNotifyServlet.java | 2 +- .../max/internal/command/CCommand.java | 2 +- .../max/internal/command/FCommand.java | 2 +- .../max/internal/command/NCommand.java | 2 +- .../max/internal/command/TCommand.java | 2 +- .../binding/max/internal/device/Device.java | 2 +- .../handler/DeviceStatusListener.java | 2 +- .../handler/MaxCubeBridgeHandler.java | 4 +- .../max/internal/message/FMessage.java | 4 +- .../max/internal/message/NMessage.java | 4 +- .../internal/handler/VehicleHandler.java | 2 +- .../internal/MeteostickBindingConstants.java | 2 +- .../miele/internal/MieleBindingConstants.java | 2 +- .../MieleMDNSDiscoveryParticipant.java | 2 +- .../handler/ApplianceStatusListener.java | 2 +- .../config/OAuthAuthorizationHandler.java | 8 ++- .../handler/AbstractMieleThingHandler.java | 2 +- .../webservice/DeviceStateListener.java | 2 +- .../internal/webservice/MieleWebservice.java | 2 +- .../webservice/api/json/ProcessAction.java | 2 +- .../openhab/binding/miio/internal/Utils.java | 2 +- .../miio/internal/cloud/CloudUtil.java | 4 +- .../internal/handler/MiIoAbstractHandler.java | 8 +-- .../miot/MiIoQuantiyTypesConversion.java | 2 +- .../internal/MilightBindingConstants.java | 2 +- .../discovery/MilightBridgeDiscovery.java | 3 - .../handler/AbstractBridgeHandler.java | 2 - .../internal/handler/AbstractLedHandler.java | 6 +- .../protocol/MilightV6SessionManager.java | 6 +- .../internal/MinecraftBindingConstants.java | 2 +- .../internal/config/PlayerConfig.java | 2 +- .../internal/config/ServerConfig.java | 2 +- .../minecraft/internal/config/SignConfig.java | 2 +- .../MinecraftMDNSDiscoveryParticipant.java | 2 +- .../modbus/e3dc/internal/modbus/Parser.java | 2 +- .../internal/HeliosEasyControlsHandler.java | 2 - .../StiebelEltronBindingConstants.java | 2 +- .../internal/StiebelEltronConfiguration.java | 2 +- .../internal/StiebelEltronHandlerFactory.java | 2 +- .../handler/StiebelEltronHandler.java | 3 +- .../modbus/studer/internal/StuderHandler.java | 5 +- .../discovery/SunspecDiscoveryProcess.java | 1 - .../handler/AbstractSunSpecHandler.java | 1 - .../modbus/ModbusBindingConstants.java | 2 +- .../internal/ModbusDiscoveryService.java | 4 +- .../handler/BaseModbusThingHandler.java | 12 ++-- .../ModbusBindingConstantsInternal.java | 2 +- .../modbus/internal/ValueTransformation.java | 2 +- .../MonopriceAudioConnector.java | 4 +- .../mpd/internal/action/MPDActions.java | 2 +- .../mpd/internal/protocol/MPDConnection.java | 4 +- .../generic/ChannelStateUpdateListener.java | 2 +- .../mapping/AbstractMqttAttributeClass.java | 4 +- .../binding/mqtt/generic/tools/ChildMap.java | 3 +- .../mqtt/homeassistant/internal/HaID.java | 2 +- .../mqtt/homie/internal/homie300/Device.java | 10 +-- .../internal/homie300/DeviceCallback.java | 4 +- .../mqtt/homie/internal/homie300/Node.java | 7 +- .../homie/internal/homie300/Property.java | 8 +-- .../binding/mqtt/handler/BrokerHandler.java | 8 +-- .../binding/mqtt/internal/MqttThingID.java | 3 +- .../internal/discovery/VehicleDiscovery.java | 2 +- .../internal/utils/VehicleStatusUtils.java | 4 +- .../neato/internal/NeatoBindingConstants.java | 2 +- .../classes/BeehiveAuthentication.java | 2 +- .../neeo/internal/NeeoHandlerCallback.java | 2 +- .../internal/NeoHubGetEngineersData.java | 1 - .../netatmo/internal/api/EnergyApi.java | 4 +- .../netatmo/internal/utils/WeatherUtils.java | 2 +- .../toberemoved/cache/ExpiringCacheAsync.java | 2 +- .../config/NibeHeatPumpConfiguration.java | 2 +- .../internal/command/GenericStatusUpdate.java | 2 +- .../connector/UplinkWebInterface.java | 2 - .../internal/handler/NibeUplinkHandler.java | 5 +- .../internal/protocol/NhcAction.java | 4 +- .../internal/protocol/NhcControllerEvent.java | 2 +- .../internal/protocol/NhcEnergyMeter.java | 5 +- .../internal/protocol/NhcThermostat.java | 6 +- .../NikoHomeControlCommunication.java | 6 +- .../protocol/nhc1/NhcThermostat1.java | 2 +- .../nhc2/NikoHomeControlCommunication2.java | 2 +- .../sds011protocol/SDS011Communicator.java | 1 - .../sds011protocol/messages/SensorReply.java | 3 +- .../ntp/internal/NtpBindingConstants.java | 2 +- .../nuki/internal/NukiHandlerFactory.java | 2 +- .../constants/NukiBindingConstants.java | 6 +- .../dataexchange/BridgeLockStateResponse.java | 2 +- .../internal/dataexchange/NukiApiServlet.java | 4 +- .../internal/dataexchange/NukiHttpClient.java | 2 +- .../internal/dto/BridgeApiLockStateDto.java | 2 +- .../dto/BridgeApiLockStateRequestDto.java | 2 +- .../internal/handler/NukiBridgeHandler.java | 2 +- .../handler/NukiSmartLockHandler.java | 4 +- .../internal/communication/NuvoConnector.java | 4 +- .../nuvo/internal/handler/NuvoHandler.java | 2 +- .../internal/api/WaterAlertWebClient.java | 2 +- .../internal/api/WaterWebService.java | 2 +- .../internal/binder/NZWaterAlertsBinder.java | 2 +- .../binder/NZWaterAlertsBinderListener.java | 2 +- .../internal/OceanicBindingConstants.java | 5 +- .../internal/BindingConstants.java | 2 +- .../internal/ThermostatHandlerFactory.java | 4 +- .../internal/common/OJGSonBuilder.java | 2 +- .../OJElectronicsBridgeConfiguration.java | 2 +- .../OJElectronicsThermostatConfiguration.java | 2 +- .../internal/services/RefreshService.java | 3 +- .../handler/AbstractOmnilinkHandler.java | 2 +- .../internal/OneBusAwayBindingConstants.java | 2 +- .../owserver/OwserverConnectionState.java | 2 +- .../onkyo/internal/OnkyoBindingConstants.java | 2 +- .../config/OnkyoDeviceConfiguration.java | 2 +- .../OpenSprinklerBindingConstants.java | 2 +- .../internal/api/OpenSprinklerApi.java | 23 ++++--- .../internal/api/OpenSprinklerApiFactory.java | 9 +-- .../api/OpenSprinklerHttpApiV210.java | 5 +- .../OpenWebNetDeviceDiscoveryService.java | 2 +- .../handler/OpenWebNetBridgeHandler.java | 2 - .../oppo/internal/handler/OppoHandler.java | 2 +- .../handler/PentairEasyTouchHandler.java | 2 +- .../phc/internal/PHCBindingConstants.java | 2 +- .../binding/phc/internal/PHCHelper.java | 2 +- .../internal/PioneerAvrBindingConstants.java | 2 +- .../internal/protocol/DisplayInformation.java | 2 - .../protocol/RequestResponseFactory.java | 1 - .../internal/protocol/avr/AvrConnection.java | 1 - .../pixometer/internal/data/MeterState.java | 3 +- .../internal/PS4ArtworkHandler.java | 4 +- .../config/PLCAnalogConfiguration.java | 2 +- .../config/PLCDateTimeConfiguration.java | 2 +- .../config/PLCMemoryConfiguration.java | 2 +- .../internal/handler/PlexPlayerHandler.java | 5 +- .../internal/PlugwiseBindingConstants.java | 2 +- .../model/dto/ActuatorFunctionalities.java | 2 +- .../config/PlugwiseHABridgeThingConfig.java | 2 +- .../config/PlugwiseHAThingConfig.java | 4 +- .../internal/PowermaxBindingConstants.java | 2 +- .../internal/connector/PowermaxConnector.java | 2 +- .../connector/PowermaxConnectorInterface.java | 2 +- .../connector/PowermaxReaderThread.java | 1 - .../internal/message/PowermaxCommManager.java | 6 +- .../internal/PulseaudioBindingConstants.java | 2 +- .../pulseaudio/internal/PulseaudioClient.java | 2 +- .../qbus/internal/QbusBridgeHandler.java | 1 - .../qbus/internal/QbusHandlerFactory.java | 2 +- .../qbus/internal/protocol/QbusBistabiel.java | 2 +- .../qbus/internal/protocol/QbusDimmer.java | 2 +- .../qbus/internal/protocol/QbusRol.java | 6 +- .../qbus/internal/protocol/QbusScene.java | 2 +- .../internal/protocol/QbusThermostat.java | 2 +- .../client/dto/action/AlarmAction.java | 2 +- .../dto/action/ArmAwayArmingAction.java | 2 +- .../client/dto/action/ArmingAction.java | 2 +- .../client/dto/action/InfoAction.java | 2 +- .../internal/client/dto/event/AlarmEvent.java | 2 +- .../client/dto/event/ArmingEvent.java | 2 +- .../internal/client/dto/event/ErrorEvent.java | 2 +- .../internal/client/dto/event/InfoEvent.java | 2 +- .../client/dto/event/SecureArmInfoEvent.java | 2 +- .../client/dto/event/SummaryInfoEvent.java | 2 +- .../client/dto/event/ZoneActiveEvent.java | 2 +- .../client/dto/event/ZoneAddEvent.java | 2 +- .../client/dto/event/ZoneUpdateEvent.java | 2 +- .../RadioThermostatBindingConstants.java | 2 +- .../RadioThermostatConnector.java | 16 ++--- .../RadioThermostatDiscoveryService.java | 7 +- .../handler/RadioThermostatHandler.java | 2 +- .../RegoHeatPumpBindingConstants.java | 2 +- .../rme/internal/RMEBindingConstants.java | 2 +- .../robonect/internal/RobonectClient.java | 2 +- .../internal/RussoundBindingConstants.java | 2 +- .../internal/rio/AbstractBridgeHandler.java | 2 +- .../internal/rio/AbstractRioProtocol.java | 4 +- .../internal/rio/AbstractThingHandler.java | 2 +- .../internal/rio/RioHandlerCallback.java | 2 +- .../internal/rio/RioPresetsProtocol.java | 2 +- .../rio/RioSystemFavoritesProtocol.java | 2 +- .../rio/controller/RioControllerHandler.java | 6 +- .../internal/rio/models/RioPreset.java | 2 +- .../internal/rio/system/RioSystemHandler.java | 4 +- .../internal/rio/zone/RioZoneHandler.java | 2 +- .../internal/SamsungTvBindingConstants.java | 2 +- .../internal/command/SatelCommandBase.java | 2 +- .../semsportal/internal/dto/SEMSToken.java | 2 +- .../semsportal/internal/dto/Station.java | 2 +- .../internal/SeneyeBindingConstants.java | 2 +- .../internal/dto/Location.java | 2 +- .../internal/channel/DeviceChannel.java | 2 +- .../channel/DeviceChannelFactory.java | 2 +- .../transform/SingleValueTransformation.java | 2 +- .../internal/api/ShellyApiException.java | 2 +- .../internal/api/ShellyEventServlet.java | 2 +- .../internal/api1/Shelly1CoIoTProtocol.java | 4 +- .../internal/api1/Shelly1CoIoTVersion1.java | 8 ++- .../internal/api1/Shelly1CoapHandler.java | 6 +- .../shelly/internal/api1/Shelly1HttpApi.java | 1 - .../internal/api2/Shelly2RpctInterface.java | 2 +- .../internal/handler/ShellyBaseHandler.java | 20 +++--- .../internal/handler/ShellyComponents.java | 10 ++- .../handler/ShellyDeviceListener.java | 3 +- .../handler/ShellyProtectedHandler.java | 7 +- .../internal/handler/ShellyRelayHandler.java | 9 +-- .../provider/ShellyChannelDefinitions.java | 2 +- .../internal/util/ShellyChannelCache.java | 2 +- .../SilvercrestWifiSocketHandlerFactory.java | 2 +- ...SilvercrestWifiSocketDiscoveryService.java | 2 +- .../SilvercrestWifiSocketMediator.java | 2 +- .../SilvercrestWifiSocketMediatorImpl.java | 2 +- .../internal/utils/ValidationUtils.java | 2 +- .../sinope/SinopeBindingConstants.java | 2 +- .../internal/SinopeConfigStatusMessage.java | 2 +- .../SinopeThingsDiscoveryService.java | 4 +- .../internal/SleepIQBindingConstants.java | 2 +- .../internal/api/dto/SleepersResponse.java | 2 +- .../internal/handler/SleepIQCloudHandler.java | 3 +- .../SMAEnergyMeterBindingConstants.java | 2 +- .../SmartMeterBindingConstants.java | 2 +- .../connectors/IMeterReaderConnector.java | 3 +- .../smartmeter/internal/MeterDevice.java | 11 +-- .../internal/sml/SmlMeterReader.java | 5 +- .../internal/sml/SmlSerialConnector.java | 3 +- .../internal/sml/SmlValueExtractor.java | 2 +- .../internal/SmartthingsBindingConstants.java | 2 +- .../internal/SmartthingsHandlerFactory.java | 1 - .../internal/SmartthingsHubCommand.java | 1 - .../internal/connector/WebInterface.java | 4 +- .../internal/handler/SolarEdgeHandler.java | 5 +- .../AbstractDataResponseTransformer.java | 4 +- .../internal/SolarLogBindingConstants.java | 2 +- .../internal/connector/SolarMaxConnector.java | 3 +- .../domain/EnergyManagerCollection.java | 3 +- .../internal/domain/SolarwattChannel.java | 2 +- .../sonos/internal/SonosBindingConstants.java | 2 +- .../sonos/internal/SonosXMLParser.java | 8 --- .../internal/handler/ZonePlayerHandler.java | 13 ++-- .../communication/SonyProjectorConnector.java | 2 +- .../internal/SoulissBindingConstants.java | 2 +- .../discovery/SoulissGatewayDiscovery.java | 4 +- .../handler/SoulissGenericActionMessage.java | 2 +- .../handler/SoulissGenericHandler.java | 3 +- .../internal/actions/SpotifyActions.java | 1 - .../spotify/internal/api/SpotifyApi.java | 5 +- .../internal/SqueezeBoxBindingConstants.java | 2 +- .../handler/SqueezeBoxServerHandler.java | 2 +- ...areDeviceCurfewListTypeAdapterFactory.java | 5 +- .../SynopAnalyzerBindingConstants.java | 2 +- .../internal/SysteminfoThingTypeProvider.java | 3 +- .../tado/internal/TadoBindingConstants.java | 2 +- .../TankerkoenigBindingConstants.java | 2 +- .../internal/TapoControlHandlerFactory.java | 2 +- .../internal/TapoDiscoveryService.java | 2 - .../internal/api/TapoDeviceConnector.java | 7 +- .../internal/api/TapoDeviceHttpApi.java | 8 +-- .../internal/device/TapoDevice.java | 4 +- .../internal/device/TapoLightStrip.java | 2 +- .../internal/device/TapoSmartBulb.java | 2 +- .../internal/device/TapoSmartPlug.java | 2 +- .../internal/device/TapoUniversalDevice.java | 2 +- .../internal/helpers/TapoCipher.java | 1 - .../internal/helpers/TapoCredentials.java | 8 +-- .../internal/helpers/TapoErrorHandler.java | 8 +-- .../internal/helpers/TapoUtils.java | 2 +- .../reader/io/TeleinfoInputStream.java | 2 - .../reader/io/serialport/FrameUtil.java | 3 +- .../internal/TellstickBindingConstants.java | 2 +- .../conf/TelldusLiveConfiguration.java | 2 +- .../conf/TelldusLocalConfiguration.java | 2 +- .../conf/TellstickBridgeConfiguration.java | 2 +- .../handler/DeviceStatusListener.java | 3 +- .../handler/TelldusBridgeHandler.java | 2 +- .../tivo/internal/TiVoBindingConstants.java | 2 +- .../tivo/internal/handler/TiVoHandler.java | 3 +- .../tivo/internal/service/TivoConfigData.java | 4 +- .../tivo/internal/service/TivoStatusData.java | 2 +- .../internal/service/TivoStatusProvider.java | 8 +-- .../TouchWandUnitStatusUpdateListener.java | 4 +- .../config/TouchwandBridgeConfiguration.java | 2 +- .../tradfri/internal/TradfriColor.java | 2 +- .../internal/action/TwitterActions.java | 2 +- .../internal/UniFiPoePortThingConfig.java | 4 +- .../api/dto/UnfiPortOverrideJsonObject.java | 2 +- .../unifi/internal/ssl/UniFiTrustManager.java | 2 +- .../UnifiedRemoteDiscoveryService.java | 7 +- .../urtsi/internal/UrtsiBindingConstants.java | 2 +- .../vdr/internal/svdrp/SVDRPClient.java | 2 - .../vdr/internal/svdrp/SVDRPClientImpl.java | 5 +- .../vdr/internal/svdrp/SVDRPTimerList.java | 1 - .../bridge/slip/SCgetHouseStatus.java | 6 +- .../bridge/slip/SCrunProductCommand.java | 2 +- .../things/VeluxExistingProducts.java | 1 - .../velux/internal/things/VeluxProduct.java | 4 +- .../internal/things/VeluxProductVelocity.java | 2 +- .../VenstarThermostatBindingConstants.java | 2 +- .../internal/dto/VenstarRuntime.java | 2 +- .../internal/dto/VenstarRuntimeData.java | 2 +- .../internal/VerisureBindingConstants.java | 2 +- .../handlers/VeSyncBaseDeviceHandler.java | 1 - .../internal/VitotronicBindingConstants.java | 2 +- .../handler/VitotronicThingHandler.java | 2 +- .../communication/VizioCommunicator.java | 18 ++--- .../WeatherCompanyForecastHandler.java | 2 +- .../WeatherUndergroundBindingConstants.java | 2 +- .../wemo/internal/WemoBindingConstants.java | 2 +- .../internal/api/WolfSmartsetApi.java | 2 +- .../handler/PublishTriggerChannel.java | 5 +- .../YamahaMusiccastHandlerFactory.java | 2 +- .../protocol/InputWithPlayControl.java | 21 ++++-- .../protocol/InputWithPresetControl.java | 3 +- .../protocol/InputWithTunerBandControl.java | 3 +- .../xml/InputWithNavigationControlXML.java | 24 ++++--- .../protocol/xml/InputWithPlayControlXML.java | 24 ++++--- .../xml/InputWithPresetControlXML.java | 8 ++- .../zway/internal/ZWayBindingConstants.java | 2 +- .../AbstractHomekitAccessoryImpl.java | 1 - .../HomekitCharacteristicFactory.java | 2 +- .../io/hueemulation/internal/RuleUtils.java | 2 +- .../internal/dto/HueUserAuth.java | 3 +- .../io/neeo/internal/NeeoBrainServlet.java | 2 +- .../internal/DynamoDBPersistenceService.java | 2 +- .../internal/PageOfInterestSubscriber.java | 2 +- .../DynamoDBTableNameResolverTest.java | 1 - .../internal/TestStoreMixedTypesTest.java | 1 - .../influxdb/internal/InfluxDBRepository.java | 2 +- .../JSonPathTransformationService.java | 2 +- .../JSonPathTransformationServiceTest.java | 2 +- .../internal/RegExTransformationService.java | 2 +- .../AbstractTransformationServiceTest.java | 2 +- .../RegExTransformationServiceTest.java | 2 +- .../internal/ScaleTransformationService.java | 2 +- .../profile/VATTransformationProfile.java | 2 +- .../internal/XPathTransformationService.java | 2 +- .../AbstractTransformationServiceTest.java | 2 +- .../XPathTransformationServiceTest.java | 2 +- .../internal/XsltTransformationService.java | 2 +- .../AbstractTransformationServiceTest.java | 2 +- .../XsltTransformationServiceTest.java | 2 +- .../googletts/internal/GoogleTTSVoice.java | 2 +- .../voice/mactts/internal/MacTTSVoice.java | 2 +- .../voice/marytts/internal/MaryTTSVoice.java | 2 +- .../pollytts/internal/PollyTTSVoice.java | 2 +- .../voicerss/internal/VoiceRSSVoice.java | 2 +- .../binding/astro/test/AstroStateTest.java | 2 +- 618 files changed, 1107 insertions(+), 1111 deletions(-) diff --git a/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyScriptEngineConfiguration.java b/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyScriptEngineConfiguration.java index ee01cb7732b92..b31c437390b8b 100644 --- a/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyScriptEngineConfiguration.java +++ b/bundles/org.openhab.automation.jrubyscripting/src/main/java/org/openhab/automation/jrubyscripting/internal/JRubyScriptEngineConfiguration.java @@ -274,7 +274,7 @@ public void injectRequire(ScriptEngine engine) { /** * Configure the optional elements of the Ruby Environment * - * @param engine Engine in which to configure environment + * @param scriptEngine Engine in which to configure environment */ public void configureRubyEnvironment(ScriptEngine scriptEngine) { getConfigurationElements(OptionalConfigurationElement.Type.RUBY_ENVIRONMENT).forEach(configElement -> { diff --git a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java index 1494f10f24e4c..7624fa21d58fc 100644 --- a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java +++ b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/AbstractScriptExtensionProvider.java @@ -67,7 +67,6 @@ public Collection getTypes() { @Override public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException { - Map forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>()); return forScript.computeIfAbsent(type, k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null); diff --git a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java index 9f73e3916efe5..99a25692427c4 100644 --- a/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java +++ b/bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/scope/ScriptDisposalAwareScriptExtensionProvider.java @@ -68,7 +68,6 @@ public Collection getTypes() { @Override public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException { - Map forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>()); return forScript.computeIfAbsent(type, k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null); diff --git a/bundles/org.openhab.binding.adorne/src/main/java/org/openhab/binding/adorne/internal/hub/AdorneHubChangeNotify.java b/bundles/org.openhab.binding.adorne/src/main/java/org/openhab/binding/adorne/internal/hub/AdorneHubChangeNotify.java index 4699e26824614..0426a6e77abc3 100644 --- a/bundles/org.openhab.binding.adorne/src/main/java/org/openhab/binding/adorne/internal/hub/AdorneHubChangeNotify.java +++ b/bundles/org.openhab.binding.adorne/src/main/java/org/openhab/binding/adorne/internal/hub/AdorneHubChangeNotify.java @@ -25,7 +25,7 @@ public interface AdorneHubChangeNotify { /** * Notify listener about state change of on/off and brightness state * - * @param zoneID zone ID for which change occurred + * @param zoneId zone ID for which change occurred * @param onOff new on/off state * @param brightness new brightness */ diff --git a/bundles/org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java b/bundles/org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java index d31384f810c94..c2948aedd4908 100644 --- a/bundles/org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java +++ b/bundles/org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java @@ -67,7 +67,7 @@ import com.google.gson.JsonObject; /** - * The {@link $AirqHandler} is responsible for retrieving all information from the air-Q device + * The {@link AirqHandler} is responsible for retrieving all information from the air-Q device * and change properties and channels accordingly. * * @author Aurelio Caliaro - Initial contribution diff --git a/bundles/org.openhab.binding.airquality/src/main/java/org/openhab/binding/airquality/internal/AirQualityBindingConstants.java b/bundles/org.openhab.binding.airquality/src/main/java/org/openhab/binding/airquality/internal/AirQualityBindingConstants.java index 4e9e006d6664f..83e66335b571d 100644 --- a/bundles/org.openhab.binding.airquality/src/main/java/org/openhab/binding/airquality/internal/AirQualityBindingConstants.java +++ b/bundles/org.openhab.binding.airquality/src/main/java/org/openhab/binding/airquality/internal/AirQualityBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link AirQualityBinding} class defines common constants, which are + * The {@link AirQualityBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Gaël L'hopital - Initial contribution 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 e1317a5849d3a..193f102d2943f 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 @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link ADCCommand} class represents an alarm decoder command, and contains the static methods and definitions + * The {@link ADCommand} class represents an alarm decoder command, and contains the static methods and definitions * used to construct one. Not all supported AD commands are necessarily used by the current binding. * * @author Bob Adair - Initial contribution diff --git a/bundles/org.openhab.binding.allplay/src/main/java/org/openhab/binding/allplay/internal/AllPlayBindingConstants.java b/bundles/org.openhab.binding.allplay/src/main/java/org/openhab/binding/allplay/internal/AllPlayBindingConstants.java index 7503750c60061..7cf95069ef83b 100644 --- a/bundles/org.openhab.binding.allplay/src/main/java/org/openhab/binding/allplay/internal/AllPlayBindingConstants.java +++ b/bundles/org.openhab.binding.allplay/src/main/java/org/openhab/binding/allplay/internal/AllPlayBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link AllPlayBinding} class defines common constants, which are + * The {@link AllPlayBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Dominic Lerbs - Initial contribution diff --git a/bundles/org.openhab.binding.amazondashbutton/src/main/java/org/openhab/binding/amazondashbutton/internal/capturing/PacketCapturingHandler.java b/bundles/org.openhab.binding.amazondashbutton/src/main/java/org/openhab/binding/amazondashbutton/internal/capturing/PacketCapturingHandler.java index 9c249eb7edfeb..45b6d7170f415 100644 --- a/bundles/org.openhab.binding.amazondashbutton/src/main/java/org/openhab/binding/amazondashbutton/internal/capturing/PacketCapturingHandler.java +++ b/bundles/org.openhab.binding.amazondashbutton/src/main/java/org/openhab/binding/amazondashbutton/internal/capturing/PacketCapturingHandler.java @@ -24,7 +24,7 @@ public interface PacketCapturingHandler { /** * Callback method to handle a captured packet. * - * @param macAddress The mac address which sent the packet + * @param sourceMacAddress The mac address which sent the packet */ void packetCaptured(MacAddress sourceMacAddress); } diff --git a/bundles/org.openhab.binding.amazonechocontrol/src/main/java/org/openhab/binding/amazonechocontrol/internal/handler/EchoHandler.java b/bundles/org.openhab.binding.amazonechocontrol/src/main/java/org/openhab/binding/amazonechocontrol/internal/handler/EchoHandler.java index 13fa2b3e81aec..e39879903942e 100644 --- a/bundles/org.openhab.binding.amazonechocontrol/src/main/java/org/openhab/binding/amazonechocontrol/internal/handler/EchoHandler.java +++ b/bundles/org.openhab.binding.amazonechocontrol/src/main/java/org/openhab/binding/amazonechocontrol/internal/handler/EchoHandler.java @@ -390,7 +390,6 @@ public void handleCommand(ChannelUID channelUID, Command command) { // shuffle command if (channelId.equals(CHANNEL_SHUFFLE)) { if (command instanceof OnOffType value) { - connection.command(device, "{\"type\":\"ShuffleCommand\",\"shuffle\":\"" + (value == OnOffType.ON ? "true" : "false") + "\"}"); } diff --git a/bundles/org.openhab.binding.androidtv/src/main/java/org/openhab/binding/androidtv/internal/protocol/googletv/GoogleTVConnectionManager.java b/bundles/org.openhab.binding.androidtv/src/main/java/org/openhab/binding/androidtv/internal/protocol/googletv/GoogleTVConnectionManager.java index 39f5b6f4bd344..3a2dd4e87aabb 100644 --- a/bundles/org.openhab.binding.androidtv/src/main/java/org/openhab/binding/androidtv/internal/protocol/googletv/GoogleTVConnectionManager.java +++ b/bundles/org.openhab.binding.androidtv/src/main/java/org/openhab/binding/androidtv/internal/protocol/googletv/GoogleTVConnectionManager.java @@ -380,7 +380,6 @@ private void setShimX509ClientChain(X509Certificate @Nullable [] shimX509ClientC } androidtvPKI.setCaCert(shimX509ClientChain[0]); androidtvPKI.saveKeyStore(config.keystorePassword, this.encryptionKey); - } } catch (Exception e) { logger.trace("setShimX509ClientChain Exception", e); diff --git a/bundles/org.openhab.binding.anthem/src/main/java/org/openhab/binding/anthem/internal/handler/AnthemCommand.java b/bundles/org.openhab.binding.anthem/src/main/java/org/openhab/binding/anthem/internal/handler/AnthemCommand.java index c05333961f3d4..921f504439b8e 100644 --- a/bundles/org.openhab.binding.anthem/src/main/java/org/openhab/binding/anthem/internal/handler/AnthemCommand.java +++ b/bundles/org.openhab.binding.anthem/src/main/java/org/openhab/binding/anthem/internal/handler/AnthemCommand.java @@ -17,7 +17,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link AnthemCommend} is responsible for creating commands to be sent to the + * The {@link AnthemCommand} is responsible for creating commands to be sent to the * Anthem processor. * * @author Mark Hilbush - Initial contribution diff --git a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/AstroBindingConstants.java b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/AstroBindingConstants.java index cd6006835100e..92cdcbff5e59a 100644 --- a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/AstroBindingConstants.java +++ b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/AstroBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link AstroBinding} class defines common constants, which are + * The {@link AstroBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Gerhard Riegler - Initial contribution diff --git a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/handler/AstroThingHandler.java b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/handler/AstroThingHandler.java index 718e7339f8263..3c4b7371b514a 100644 --- a/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/handler/AstroThingHandler.java +++ b/bundles/org.openhab.binding.astro/src/main/java/org/openhab/binding/astro/internal/handler/AstroThingHandler.java @@ -294,8 +294,6 @@ public void triggerEvent(String channelId, String event) { /** * Adds the provided {@link Job} to the queue (cannot be {@code null}) - * - * @return {@code true} if the {@code job} is added to the queue, otherwise {@code false} */ public void schedule(Job job, Calendar eventAt) { long sleepTime; diff --git a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtHttpClient.java b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtHttpClient.java index e8cd515f0252d..8853096b16c71 100644 --- a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtHttpClient.java +++ b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/api/AsuswrtHttpClient.java @@ -62,7 +62,7 @@ public AsuswrtHttpClient(AsuswrtRouter router) { /** * Sends a synchronous HTTP request. * - * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or + * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or * {@link #handleHttpResultError(Throwable)}. * * If the response should be returned use {@link #getSyncRequest(String, String)} instead. @@ -106,7 +106,7 @@ protected void sendSyncRequest(String url, String payload, String command) { /** * Sends an asynchronous HTTP request so it does not wait for an answer. * - * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or + * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or * {@link #handleHttpResultError(Throwable)}. * * @param url the URL to which the request is sent to diff --git a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java index 577566619b014..0ab36ed21d216 100644 --- a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java +++ b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/helpers/AsuswrtErrorHandler.java @@ -39,7 +39,7 @@ public AsuswrtErrorHandler(Exception ex) { /** * Raises a new error. * - * @param exception the exception + * @param ex the exception */ public void raiseError(Exception ex) { raiseError(ex, ""); @@ -48,7 +48,7 @@ public void raiseError(Exception ex) { /** * Raises a new error. * - * @param exception the exception + * @param ex the exception * @param infoMessage optional info message */ public void raiseError(Exception ex, @Nullable String infoMessage) { diff --git a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/structures/AsuswrtIpInfo.java b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/structures/AsuswrtIpInfo.java index c11d2a5ceda43..3653002771352 100644 --- a/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/structures/AsuswrtIpInfo.java +++ b/bundles/org.openhab.binding.asuswrt/src/main/java/org/openhab/binding/asuswrt/internal/structures/AsuswrtIpInfo.java @@ -46,7 +46,7 @@ public AsuswrtIpInfo() { /** * Constructor. * - * @param interfaceName name of interface + * @param ifName name of interface * @param jsonObject with ipInfo */ public AsuswrtIpInfo(String ifName, JsonObject jsonObject) { 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 a9b0a52884cc7..e2b6922d4fdca 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 @@ -393,7 +393,7 @@ public void updateClientChannels(AsuswrtClientList clientList) { /** * Fire Event * - * @param channelUID chanelUID event belongs to + * @param channel chanelUID event belongs to * @param event event-name is fired */ protected void fireEvent(String channel, String event) { diff --git a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaBindingConstants.java b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaBindingConstants.java index 0a8beb504c09f..41fcfde879719 100644 --- a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaBindingConstants.java +++ b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link AtlonaBinding} class defines common constants, which are used across the whole binding. + * The {@link AtlonaBindingConstants} class defines common constants, which are used across the whole binding. * * @author Tim Roberts - Initial contribution * @author Michael Lobstein - Add support for AT-PRO3HD 44/66 M diff --git a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaHandlerCallback.java b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaHandlerCallback.java index d6a2c946708d6..5258e8d5fbe74 100644 --- a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaHandlerCallback.java +++ b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/AtlonaHandlerCallback.java @@ -20,14 +20,16 @@ /** * - * A callback to {@link AtlonaHandler} that can be used to update the status, properties and state of the thing. + * A callback to {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler} + * that can be used to update the status, properties and state of the thing. * * @author Tim Roberts - Initial contribution */ @NonNullByDefault public interface AtlonaHandlerCallback { /** - * Callback to the {@link AtlonaHandler} to update the status of the thing. + * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler} + * to update the status of the thing. * * @param status a non-null {@link org.openhab.core.thing.ThingStatus} * @param detail a non-null {@link org.openhab.core.thing.ThingStatusDetail} @@ -36,15 +38,17 @@ public interface AtlonaHandlerCallback { void statusChanged(ThingStatus status, ThingStatusDetail detail, @Nullable String msg); /** - * Callback to the {@link AtlonaHandler} to update the state of an item + * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler} + * to update the state of an item * * @param channelId the non-null, non-empty channel id - * @param state the new non-null {@State} + * @param state the new non-null {@link State} */ void stateChanged(String channelId, State state); /** - * Callback to the {@link AtlonaHandler} to update the property of a thing + * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler} + * to update the property of a thing * * @param propertyName a non-null, non-empty property name * @param propertyValue a non-null, possibly empty property value diff --git a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Config.java b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Config.java index 97fc3ce971778..bde5cdb823c50 100644 --- a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Config.java +++ b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Config.java @@ -20,7 +20,8 @@ public class AtlonaPro3Config { /** - * Constant field used in {@link AtlonaDiscovery} to set the config property during discovery. Value of this field + * Constant field used in {@link org.openhab.binding.atlona.internal.discovery.AtlonaDiscovery} + * to set the config property during discovery. Value of this field * needs to match {@link #ipAddress} */ public static final String IP_ADDRESS = "ipAddress"; diff --git a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Handler.java b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Handler.java index 8dcc8b5ba3438..2186fa0e777cf 100644 --- a/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Handler.java +++ b/bundles/org.openhab.binding.atlona/src/main/java/org/openhab/binding/atlona/internal/pro3/AtlonaPro3Handler.java @@ -116,7 +116,8 @@ public AtlonaPro3Handler(Thing thing, AtlonaPro3Capabilities capabilities) { * Handles commands to specific channels. This implementation will offload much of its work to the * {@link AtlonaPro3PortocolHandler}. Basically we validate the type of command for the channel then call the * {@link AtlonaPro3PortocolHandler} to handle the actual protocol. Special use case is the {@link RefreshType} - * where we call {{@link #handleRefresh(String)} to handle a refresh of the specific channel (which in turn calls + * where we call {{@link #handleRefresh(ChannelUID)} to handle a refresh of the specific channel (which in turn + * calls * {@link AtlonaPro3PortocolHandler} to handle the actual refresh */ @Override diff --git a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/AutelisBindingConstants.java b/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/AutelisBindingConstants.java index d2f6bd21cde44..f6eda58a3fc2d 100644 --- a/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/AutelisBindingConstants.java +++ b/bundles/org.openhab.binding.autelis/src/main/java/org/openhab/binding/autelis/internal/AutelisBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link AutelisBinding} class defines common constants, which are used + * The {@link AutelisBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Dan Cunningham - Initial contribution diff --git a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/AutomowerBindingConstants.java b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/AutomowerBindingConstants.java index 2a1ba489511d6..55f5f283e51b7 100644 --- a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/AutomowerBindingConstants.java +++ b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/AutomowerBindingConstants.java @@ -23,7 +23,7 @@ * used across the whole binding. * * @author Markus Pfleger - Initial contribution - * @author Marcin Czeczko - Added support for planner & calendar data + * @author Marcin Czeczko - Added support for planner and calendar data */ @NonNullByDefault public class AutomowerBindingConstants { diff --git a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Calendar.java b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Calendar.java index 1aa301f492971..d516eaa8a5f8d 100644 --- a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Calendar.java +++ b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Calendar.java @@ -17,7 +17,7 @@ /** * @author Markus Pfleger - Initial contribution - * @author Marcin Czeczko - Added support for planner & calendar data + * @author Marcin Czeczko - Added support for planner and calendar data */ public class Calendar { private List tasks = new ArrayList<>(); diff --git a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Planner.java b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Planner.java index 30291a908496b..76852ea0cbac4 100644 --- a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Planner.java +++ b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/rest/api/automowerconnect/dto/Planner.java @@ -14,7 +14,7 @@ /** * @author Markus Pfleger - Initial contribution - * @author Marcin Czeczko - Added support for planner & calendar data + * @author Marcin Czeczko - Added support for planner and calendar data */ public class Planner { private long nextStartTimestamp; diff --git a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java index 2c8f32f2cf996..64a2151320d8b 100644 --- a/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java +++ b/bundles/org.openhab.binding.automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java @@ -68,7 +68,7 @@ * sent to one of the channels. * * @author Markus Pfleger - Initial contribution - * @author Marcin Czeczko - Added support for planner & calendar data + * @author Marcin Czeczko - Added support for planner and calendar data */ @NonNullByDefault public class AutomowerHandler extends BaseThingHandler { diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/ColorControlModel.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/ColorControlModel.java index c0d644a1fe22e..3c69911adec80 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/ColorControlModel.java +++ b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/ColorControlModel.java @@ -47,7 +47,7 @@ public class ColorControlModel { /** * Converts a FRITZ!Box value to a percent value. * - * @param fritzValue The FRITZ!Box value to be converted + * @param saturation The FRITZ!Box value to be converted * @return The percent value */ public static PercentType toPercent(int saturation) { diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/ApplyMaskListModel.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/ApplyMaskListModel.java index 18008a994d9c7..5680aaed9e204 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/ApplyMaskListModel.java +++ b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/ApplyMaskListModel.java @@ -17,7 +17,7 @@ import javax.xml.bind.annotation.XmlRootElement; /** - * See {@ TemplateModel}. + * See {@link TemplateModel}. * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/DeviceListModel.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/DeviceListModel.java index a12a9865e8e7a..a7b6c619cdddc 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/DeviceListModel.java +++ b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/dto/templates/DeviceListModel.java @@ -21,7 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; /** - * See {@ TemplateModel}. + * See {@link TemplateModel}. * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/callbacks/FritzAhaSetLevelPercentageCallback.java b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/callbacks/FritzAhaSetLevelPercentageCallback.java index 62721033d8eb2..b831739500e12 100644 --- a/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/callbacks/FritzAhaSetLevelPercentageCallback.java +++ b/bundles/org.openhab.binding.avmfritz/src/main/java/org/openhab/binding/avmfritz/internal/hardware/callbacks/FritzAhaSetLevelPercentageCallback.java @@ -38,7 +38,7 @@ public class FritzAhaSetLevelPercentageCallback extends FritzAhaReauthCallback { * * @param webIface Interface to FRITZ!Box * @param ain AIN of the device that should be switched - * @param level Opening level percentage (0 ... 100) + * @param levelPercentage Opening level percentage (0 ... 100) */ public FritzAhaSetLevelPercentageCallback(FritzAhaWebInterface webIface, String ain, BigDecimal levelPercentage) { super(WEBSERVICE_PATH, "switchcmd=setlevelpercentage&level=" + levelPercentage + "&ain=" + ain, webIface, GET, diff --git a/bundles/org.openhab.binding.benqprojector/src/main/java/org/openhab/binding/benqprojector/internal/handler/BenqProjectorHandler.java b/bundles/org.openhab.binding.benqprojector/src/main/java/org/openhab/binding/benqprojector/internal/handler/BenqProjectorHandler.java index a8969ec4bec2a..aefbdb995968a 100644 --- a/bundles/org.openhab.binding.benqprojector/src/main/java/org/openhab/binding/benqprojector/internal/handler/BenqProjectorHandler.java +++ b/bundles/org.openhab.binding.benqprojector/src/main/java/org/openhab/binding/benqprojector/internal/handler/BenqProjectorHandler.java @@ -49,7 +49,7 @@ * The {@link BenqProjectorHandler} is responsible for handling commands, which are * sent to one of the channels. * - * Based on 'epsonprojector' originally by Pauli Anttila & Yannick Schaus + * Based on 'epsonprojector' originally by Pauli Anttila and Yannick Schaus * * @author Michael Lobstein - Initial contribution */ diff --git a/bundles/org.openhab.binding.bluetooth.airthings/src/main/java/org/openhab/binding/bluetooth/airthings/internal/AirthingsConfiguration.java b/bundles/org.openhab.binding.bluetooth.airthings/src/main/java/org/openhab/binding/bluetooth/airthings/internal/AirthingsConfiguration.java index be4fb901c26dc..09ddc0b24bc54 100644 --- a/bundles/org.openhab.binding.bluetooth.airthings/src/main/java/org/openhab/binding/bluetooth/airthings/internal/AirthingsConfiguration.java +++ b/bundles/org.openhab.binding.bluetooth.airthings/src/main/java/org/openhab/binding/bluetooth/airthings/internal/AirthingsConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration class for {@link AirthingsBinding} device. + * Configuration class for Airthings device. * * @author Pauli Anttila - Initial contribution */ diff --git a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/BlueGigaBluetoothDevice.java b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/BlueGigaBluetoothDevice.java index 0aa8377b0f72f..78fabcf5edea1 100644 --- a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/BlueGigaBluetoothDevice.java +++ b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/BlueGigaBluetoothDevice.java @@ -58,7 +58,7 @@ import org.slf4j.LoggerFactory; /** - * An extended {@link BluetoothDevice} class to handle BlueGiga specific information + * An extended {@link BaseBluetoothDevice} class to handle BlueGiga specific information * * @author Chris Jackson - Initial contribution */ @@ -130,7 +130,7 @@ public void run() { }; /** - * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BluetoothDevice} for the BlueGiga + * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BaseBluetoothDevice} for the BlueGiga * implementation * * @param bgHandler the {@link BlueGigaBridgeHandler} that provides the link to the dongle diff --git a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/handler/BlueGigaBridgeHandler.java b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/handler/BlueGigaBridgeHandler.java index 27e244ae99ee6..2b6286dd442b1 100644 --- a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/handler/BlueGigaBridgeHandler.java +++ b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/handler/BlueGigaBridgeHandler.java @@ -781,7 +781,6 @@ public void removeEventListener(BlueGigaEventListener listener) { public void bluegigaEventReceived(@Nullable BlueGigaResponse event) { if (event instanceof BlueGigaScanResponseEvent scanEvent) { if (initComplete) { - // We use the scan event to add any devices we hear to the devices list // The device gets created, and then manages itself for discovery etc. BluetoothAddress sender = new BluetoothAddress(scanEvent.getSender()); diff --git a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/BlueGigaTransactionManager.java b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/BlueGigaTransactionManager.java index b62e68da9db3b..3f5ef550ddb20 100644 --- a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/BlueGigaTransactionManager.java +++ b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/BlueGigaTransactionManager.java @@ -142,7 +142,7 @@ private Optional getNextFrame() { * FIFO queue. This method queues a {@link BlueGigaCommand} frame without * waiting for a response. * - * @param transaction + * @param request * {@link BlueGigaUniqueCommand} */ public void queueFrame(BlueGigaUniqueCommand request) { @@ -245,7 +245,6 @@ public boolean transactionEvent(BlueGigaResponse bleResponse, int transactionId) if (bleCommand instanceof BlueGigaDeviceCommand devCommand && bleResponse instanceof BlueGigaDeviceResponse devResponse) { - logger.trace("Expected connection id: {}, received connection id: {}", devCommand.getConnection(), devResponse.getConnection()); diff --git a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirDataType.java b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirDataType.java index bd48eeb4a0d78..0158b3d23f348 100644 --- a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirDataType.java +++ b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirDataType.java @@ -85,7 +85,7 @@ private EirDataType(int key) { /** * Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist. * - * @param bluetoothAddressType + * @param eirDataType * the code to lookup * @return enumeration value. */ diff --git a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirFlags.java b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirFlags.java index 4a7f2ad8ac867..f5f8bbf9fb5e1 100644 --- a/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirFlags.java +++ b/bundles/org.openhab.binding.bluetooth.bluegiga/src/main/java/org/openhab/binding/bluetooth/bluegiga/internal/eir/EirFlags.java @@ -59,7 +59,7 @@ private EirFlags(int key) { /** * Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist. * - * @param bluetoothAddressType + * @param eirFlag * the code to lookup * @return enumeration value. */ diff --git a/bundles/org.openhab.binding.bluetooth.bluez/src/main/java/org/openhab/binding/bluetooth/bluez/internal/BlueZBluetoothDevice.java b/bundles/org.openhab.binding.bluetooth.bluez/src/main/java/org/openhab/binding/bluetooth/bluez/internal/BlueZBluetoothDevice.java index 5eba04c9b8863..d92bc360974d7 100644 --- a/bundles/org.openhab.binding.bluetooth.bluez/src/main/java/org/openhab/binding/bluetooth/bluez/internal/BlueZBluetoothDevice.java +++ b/bundles/org.openhab.binding.bluetooth.bluez/src/main/java/org/openhab/binding/bluetooth/bluez/internal/BlueZBluetoothDevice.java @@ -77,7 +77,6 @@ public class BlueZBluetoothDevice extends BaseBluetoothDevice implements BlueZEv * * @param adapter the bridge handler through which this device is connected * @param address the Bluetooth address of the device - * @param name the name of the device */ public BlueZBluetoothDevice(BlueZBridgeHandler adapter, BluetoothAddress address) { super(adapter, address); diff --git a/bundles/org.openhab.binding.bluetooth.govee/src/main/java/org/openhab/binding/bluetooth/gattserial/MessageHandler.java b/bundles/org.openhab.binding.bluetooth.govee/src/main/java/org/openhab/binding/bluetooth/gattserial/MessageHandler.java index 9d94ad9eb9b69..a96de9a86b27e 100644 --- a/bundles/org.openhab.binding.bluetooth.govee/src/main/java/org/openhab/binding/bluetooth/gattserial/MessageHandler.java +++ b/bundles/org.openhab.binding.bluetooth.govee/src/main/java/org/openhab/binding/bluetooth/gattserial/MessageHandler.java @@ -23,14 +23,15 @@ public interface MessageHandler { /** * - * @param payload + * @param message * @return true if this handler should be removed from the handler list */ boolean handleReceivedMessage(R message); /** * - * @param payload + * @param message + * @param th * @return true if this handler should be removed from the handler list */ boolean handleFailedMessage(T message, Throwable th); diff --git a/bundles/org.openhab.binding.bluetooth.radoneye/src/main/java/org/openhab/binding/bluetooth/radoneye/internal/RadoneyeConfiguration.java b/bundles/org.openhab.binding.bluetooth.radoneye/src/main/java/org/openhab/binding/bluetooth/radoneye/internal/RadoneyeConfiguration.java index d59de8be36c95..a52aa3c74b819 100644 --- a/bundles/org.openhab.binding.bluetooth.radoneye/src/main/java/org/openhab/binding/bluetooth/radoneye/internal/RadoneyeConfiguration.java +++ b/bundles/org.openhab.binding.bluetooth.radoneye/src/main/java/org/openhab/binding/bluetooth/radoneye/internal/RadoneyeConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration class for {@link RadoneyeBinding} device. + * Configuration class for Radoneye device. * * @author Peter Obel - Initial contribution */ diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java index c56dacaff10d0..1d18a53ec1dfc 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java @@ -94,7 +94,7 @@ public abstract class BaseBluetoothDevice extends BluetoothDevice { * Construct a Bluetooth device taking the Bluetooth address * * @param adapter - * @param sender + * @param address */ public BaseBluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) { super(adapter, address); @@ -170,7 +170,7 @@ public Collection getServices() { /** * Sets the device transmit power * - * @param power the current transmitter power in dBm + * @param txPower the current transmitter power in dBm */ public void setTxPower(int txPower) { this.txPower = txPower; diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java index a0620334014a6..485299031bdab 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java @@ -230,9 +230,7 @@ public int getHandle() { } /** - * Get the service to which this characteristic belongs - * - * @return the {@link BluetoothService} + * Set the service to which this characteristic belongs */ public void setService(BluetoothService service) { this.service = service; diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java index 1cff9dbe27494..d2e2452ac3fd3 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java @@ -91,7 +91,7 @@ protected enum BluetoothEventType { * Construct a Bluetooth device taking the Bluetooth address * * @param adapter - * @param sender + * @param address */ public BluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) { this.address = address; @@ -175,7 +175,7 @@ public BluetoothAdapter getAdapter() { /** * Connects to a device. This is an asynchronous method. Once the connection state is updated, the - * {@link BluetoothDeviceListener.onConnectionState} method will be called with the connection state. + * {@link BluetoothDeviceListener#onConnectionStateChange} method will be called with the connection state. *

* If the device is already connected, this will return false. * @@ -185,7 +185,7 @@ public BluetoothAdapter getAdapter() { /** * Disconnects from a device. Once the connection state is updated, the - * {@link BluetoothDeviceListener.onConnectionState} + * {@link BluetoothDeviceListener#onConnectionStateChange} * method will be called with the connection state. *

* If the device is not currently connected, this will return false. diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java index e813a306d73b8..b8537c4f64537 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java @@ -76,7 +76,7 @@ public void setManufacturerId(int manufacturer) { /** * Sets the device transmit power * - * @param power the current transmitter power in dBm + * @param txPower the current transmitter power in dBm */ public void setTxPower(int txPower) { this.txPower = txPower; @@ -104,7 +104,7 @@ public void setModel(String model) { /** * Set the serial number of the device * - * @param model a {@link String} defining the serial number + * @param serialNumber a {@link String} defining the serial number */ public void setSerialNumberl(String serialNumber) { this.serialNumber = serialNumber; @@ -113,7 +113,7 @@ public void setSerialNumberl(String serialNumber) { /** * Set the hardware revision of the device * - * @param model a {@link String} defining the hardware revision + * @param hardwareRevision a {@link String} defining the hardware revision */ public void setHardwareRevision(String hardwareRevision) { this.hardwareRevision = hardwareRevision; @@ -122,7 +122,7 @@ public void setHardwareRevision(String hardwareRevision) { /** * Set the firmware revision of the device * - * @param model a {@link String} defining the firmware revision + * @param firmwareRevision a {@link String} defining the firmware revision */ public void setFirmwareRevision(String firmwareRevision) { this.firmwareRevision = firmwareRevision; @@ -131,7 +131,7 @@ public void setFirmwareRevision(String firmwareRevision) { /** * Set the software revision of the device * - * @param model a {@link String} defining the software revision + * @param softwareRevision a {@link String} defining the software revision */ public void setSoftwareRevision(String softwareRevision) { this.softwareRevision = softwareRevision; @@ -207,8 +207,6 @@ public boolean equals(@Nullable Object obj) { /** * This merges non-null identity fields from the given device into this snapshot. - * - * @return true if this snapshot changed as a result of this operation */ public void merge(BluetoothDeviceSnapshot device) { Integer txPower = device.getTxPower(); diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java index 323f63dd71011..e3cc5e7ff1a1c 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java @@ -47,7 +47,7 @@ /** * The {@link BluetoothDiscoveryProcess} does the work of creating a DiscoveryResult from a set of - * {@link BluetoothDisocveryParticipant}s + * {@link BluetoothDiscoveryParticipant}s * * @author Connor Petty - Initial Contribution */ diff --git a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java index 77ba53d13c0b3..115346188d1b4 100644 --- a/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java +++ b/bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java @@ -131,7 +131,7 @@ public Map getServiceData() { /** * Sets the beacon type for this packet * - * @beaconType the {@link BluetoothBeaconType} for this packet + * @param beaconType the {@link BluetoothBeaconType} for this packet */ public void setBeaconType(BluetoothBeaconType beaconType) { this.beaconType = beaconType; 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 89a7e44d7b395..72ea73b14e24e 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 @@ -66,7 +66,7 @@ public class BPUPListener implements Runnable { /** * Constructor of the receiver runnable thread. * - * @param address The address of the Bond Bridge + * @param bridgeHandler The handler of the Bond Bridge * @throws SocketException is some problem occurs opening the socket. */ public BPUPListener(BondBridgeHandler bridgeHandler) { diff --git a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BondHttpApi.java b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BondHttpApi.java index 97b9ec8880ee6..a9c0b9fc1fef3 100644 --- a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BondHttpApi.java +++ b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/api/BondHttpApi.java @@ -169,7 +169,7 @@ public BondDeviceProperties getDeviceProperties(String deviceId) throws BondExce * Executes a device action * * @param deviceId The ID of the device - * @param actionId The Bond action + * @param action The Bond action * @param argument An additional argument for the actions (such as the fan speed) */ public synchronized void executeDeviceAction(String deviceId, BondDeviceAction action, @Nullable Integer argument) { diff --git a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/config/BondDeviceConfiguration.java b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/config/BondDeviceConfiguration.java index ae2ef6f7bfa31..a283c46455431 100644 --- a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/config/BondDeviceConfiguration.java +++ b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/config/BondDeviceConfiguration.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link BondHomeConfiguration} class contains fields mapping thing configuration parameters. + * The {@link BondDeviceConfiguration} class contains fields mapping thing configuration parameters. * * @author Sara Geleskie Damiano - Initial contribution */ diff --git a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/handler/BondBridgeHandler.java b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/handler/BondBridgeHandler.java index ed779d454ed65..35cd1806c2c0f 100644 --- a/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/handler/BondBridgeHandler.java +++ b/bundles/org.openhab.binding.bondhome/src/main/java/org/openhab/binding/bondhome/internal/handler/BondBridgeHandler.java @@ -198,7 +198,7 @@ public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) { /** * Forwards a push update to a device * - * @param the {@link BPUPUpdate object} + * @param pushUpdate the {@link BPUPUpdate object} */ public void forwardUpdateToThing(BPUPUpdate pushUpdate) { updateStatus(ThingStatus.ONLINE); diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/AuthorizationListener.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/AuthorizationListener.java index a57c1f4c439d6..6573dfe7de8be 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/AuthorizationListener.java +++ b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/AuthorizationListener.java @@ -15,8 +15,10 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * {@link} AuthorizationListener} is used for notifying {@link BoschAccountHandler} - * when authorization state has changed and for notifying {@link BoschIndegoHandler} + * {@link AuthorizationListener} is used for notifying + * {@link org.openhab.binding.boschindego.internal.handler.BoschAccountHandler} + * when authorization state has changed and for notifying + * {@link org.openhab.binding.boschindego.internal.handler.BoschIndegoHandler} * when authorization flow is completed. * * @author Jacob Laursen - Initial contribution diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/BoschIndegoBindingConstants.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/BoschIndegoBindingConstants.java index f24eff511c8c2..6d17b47ad4b7b 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/BoschIndegoBindingConstants.java +++ b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/BoschIndegoBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link BoschIndegoBinding} class defines common constants, which are + * The {@link BoschIndegoBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Jonas Fleck - Initial contribution 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 2cf326001dbba..9990699622c31 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,7 +261,8 @@ protected void postRequest(String path) throws IndegoAuthenticationException, In /** * Sends a PUT/POST request to the server. * - * @param method the type of request ({@link HttpMethod.PUT} or {@link HttpMethod.POST}) + * @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or + * {@link org.eclipse.jetty.http.HttpMethod.POST}) * @param path the relative path to which the request should be sent * @param requestDto the DTO which should be sent to the server as JSON * @throws IndegoAuthenticationException if request was rejected as unauthorized diff --git a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/dto/response/runtime/DeviceStateRuntimes.java b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/dto/response/runtime/DeviceStateRuntimes.java index 435592a4411d5..1d7992e2d7626 100644 --- a/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/dto/response/runtime/DeviceStateRuntimes.java +++ b/bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/dto/response/runtime/DeviceStateRuntimes.java @@ -14,7 +14,8 @@ package org.openhab.binding.boschindego.internal.dto.response.runtime; /** - * Total/session runtime information for {@link DeviceStateResponse} + * Total/session runtime information for + * {@link org.openhab.binding.boschindego.internal.dto.response.DeviceStateResponse} * * @author Jacob Laursen - Initial contribution */ 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 a6e9747650b2a..3298af12f04cf 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 @@ -114,7 +114,7 @@ protected BoschSHCHandler(Thing thing) { /** * Initializes this handler. Use this method to register all services of the device with - * {@link #registerService(BoschSHCService)}. + * {@link #registerService(TService, Consumer, Collection, boolean)}. */ @Override public void initialize() { 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 9d5393169766e..f3704c5869c17 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 @@ -103,7 +103,7 @@ public String getBoschShcUrl(String endpoint) { } /** - * Returns a SmartHome URL for the endpoint - shortcut of {@link BoschSslUtil::getBoschShcUrl()} + * Returns a SmartHome URL for the endpoint - shortcut of {@link #getBoschShcUrl(String)} * * @param endpoint an endpoint, see https://apidocs.bosch-smarthome.com/local/index.html * @return SmartHome URL for passed endpoint diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/childlock/dto/ChildLockServiceState.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/childlock/dto/ChildLockServiceState.java index ae5592b5217af..2b7204d02cd96 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/childlock/dto/ChildLockServiceState.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/childlock/dto/ChildLockServiceState.java @@ -16,8 +16,8 @@ import org.openhab.core.library.types.OnOffType; /** - * State for {@link ChildLockService} to activate and deactivate the child lock - * of a device. + * State for {@link org.openhab.binding.boschshc.internal.services.childlock.ChildLockService} + * to activate and deactivate the child lock of a device. * * @author Christian Oeing - Initial contribution */ diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/powermeter/dto/PowerMeterServiceState.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/powermeter/dto/PowerMeterServiceState.java index 9123a542db4a2..741b1bb99b405 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/powermeter/dto/PowerMeterServiceState.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/powermeter/dto/PowerMeterServiceState.java @@ -15,7 +15,7 @@ import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState; /** - * State for {@link PowerMeterService} + * State for {@link org.openhab.binding.boschshc.internal.services.powermeter.PowerMeterService} * * @author Stefan Kästle - Initial contribution */ 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 d0fd47ca7656e..e9081abf88d31 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.openhab.core.thing.ThingTypeUID; /** - * The {@link BoseSoundTouchBindinConstantsg} class defines common constants, which are + * The {@link BoseSoundTouchBindinConstants} class defines common constants, which are * used across the whole binding. * * @author Christian Niessner - Initial contribution 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 8fabbd52fd03b..66707ccc2ba24 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 @@ -266,7 +266,7 @@ public void postPreset(DecimalType command) { /** * Post RemoteKey on the device * - * @param command the command is Type of RemoteKeyType + * @param key the key is Type of RemoteKeyType */ public void postRemoteKey(RemoteKeyType key) { sendPostRequestInWebSocket("key", "mainNode=\"keyPress\"", diff --git a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/PresetContainer.java b/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/PresetContainer.java index a6ce2f2dfc31b..fcd160ef33fdf 100644 --- a/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/PresetContainer.java +++ b/bundles/org.openhab.binding.bosesoundtouch/src/main/java/org/openhab/binding/bosesoundtouch/internal/PresetContainer.java @@ -51,8 +51,6 @@ public PresetContainer(Storage storage) { /** * Returns a Collection of all Presets - * - * @param operationModeType */ public Collection getAllPresets() { return mapOfPresets.values(); diff --git a/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/discovery/BroadlinkDiscoveryService.java b/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/discovery/BroadlinkDiscoveryService.java index 714003afc165e..8b54a01980563 100644 --- a/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/discovery/BroadlinkDiscoveryService.java +++ b/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/discovery/BroadlinkDiscoveryService.java @@ -68,7 +68,6 @@ public BroadlinkDiscoveryService(@Reference NetworkAddressService networkAddress } private void createScanner() { - long timestampOfLastScan = getTimestampOfLastScan(); BLDevice[] blDevices = new BLDevice[0]; try { diff --git a/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/handler/FloureonThermostatHandler.java b/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/handler/FloureonThermostatHandler.java index 644395b0a2dc9..ce29d7ff10b21 100644 --- a/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/handler/FloureonThermostatHandler.java +++ b/bundles/org.openhab.binding.broadlinkthermostat/src/main/java/org/openhab/binding/broadlinkthermostat/internal/handler/FloureonThermostatHandler.java @@ -262,7 +262,6 @@ public void dispose() { } protected void refreshData() { - AdvancedStatusInfo advancedStatusInfo = advancedStatusInfoExpiringCache.getValue(); if (advancedStatusInfo == null) { return; diff --git a/bundles/org.openhab.binding.bsblan/src/main/java/org/openhab/binding/bsblan/internal/helper/BsbLanParameterConverter.java b/bundles/org.openhab.binding.bsblan/src/main/java/org/openhab/binding/bsblan/internal/helper/BsbLanParameterConverter.java index c1bd31c32a3cb..711735fa0c301 100644 --- a/bundles/org.openhab.binding.bsblan/src/main/java/org/openhab/binding/bsblan/internal/helper/BsbLanParameterConverter.java +++ b/bundles/org.openhab.binding.bsblan/src/main/java/org/openhab/binding/bsblan/internal/helper/BsbLanParameterConverter.java @@ -28,7 +28,7 @@ import org.unbescape.html.HtmlEscape; /** - * The {@link BsbLanParameterHandler} is responsible for updating the data, which are + * The {@link BsbLanParameterConverter} is responsible for updating the data, which are * sent to one of the channels. * * @author Peter Schraffl - Initial contribution 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 9e36cf2771225..4fc099dc15382 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 @@ -82,8 +82,7 @@ public interface SmartherAccountHandler extends ThingHandler { * * @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ List getSubscriptions() throws SmartherGatewayException; @@ -97,8 +96,7 @@ public interface SmartherAccountHandler extends ThingHandler { * * @return the identifier this subscription has been registered under * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException; @@ -110,10 +108,7 @@ public interface SmartherAccountHandler extends ThingHandler { * @param subscriptionId * the identifier of the subscription to be removed for the given plant * - * @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise - * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ void unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException; @@ -138,21 +133,19 @@ public interface SmartherAccountHandler extends ThingHandler { * * @return the current status of the chronothermostat module * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException; /** * Sends new settings to be applied to a given chronothermostat module. * - * @param settings + * @param moduleSettings * the module settings to be applied * * @return {@code true} if the settings have been successfully applied, {@code false} otherwise * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ boolean setModuleStatus(ModuleSettings moduleSettings) throws SmartherGatewayException; @@ -166,8 +159,7 @@ public interface SmartherAccountHandler extends ThingHandler { * * @return the list of registered programs, or an empty {@link List} in case of no programs found * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ List getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException; diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountService.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountService.java index d7f04f2675587..f5a49a4176465 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountService.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherAccountService.java @@ -163,8 +163,8 @@ private String readTemplate(String templateName) throws IOException { * * @return a string containing the name of the authorized BTicino/Legrand portal user * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API or no account handler found + * @throws SmartherGatewayException in case of communication issues with the Smarther API or no account handler + * found */ public String dispatchAuthorization(String servletBaseURL, String state, String code) throws SmartherGatewayException { @@ -191,8 +191,8 @@ public String dispatchAuthorization(String servletBaseURL, String state, String * @param notification * the received notification to handle * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API or no notification handler found + * @throws SmartherGatewayException in case of communication issues with the Smarther API or no notification handler + * found */ public void dispatchNotification(Notification notification) throws SmartherGatewayException { final Sender sender = notification.getSender(); diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherNotificationHandler.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherNotificationHandler.java index 739e34f41da19..5046d2235345b 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherNotificationHandler.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/account/SmartherNotificationHandler.java @@ -39,8 +39,7 @@ public interface SmartherNotificationHandler extends ThingHandler { * @param plantId * the identifier of the plant the notification endpoint belongs to * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ void registerNotification(String plantId) throws SmartherGatewayException; @@ -58,8 +57,7 @@ public interface SmartherNotificationHandler extends ThingHandler { * @param plantId * the identifier of the plant the notification endpoint belongs to * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the Smarther API + * @throws SmartherGatewayException in case of communication issues with the Smarther API */ void unregisterNotification(String plantId) throws SmartherGatewayException; } diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApi.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApi.java index 16d2423953ba6..c9d1c167bd326 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApi.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApi.java @@ -125,8 +125,7 @@ public SmartherApi(final OAuthClientService clientService, final String subscrip * * @return the list of registered plants, or an empty {@link List} in case of no plants found * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public List getPlants() throws SmartherGatewayException { try { @@ -149,8 +148,7 @@ public List getPlants() throws SmartherGatewayException { * * @return the list of registered modules, or an empty {@link List} in case the plant contains no module * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public List getPlantModules(String plantId) throws SmartherGatewayException { try { @@ -172,8 +170,7 @@ public List getPlantModules(String plantId) throws SmartherGatewayExcept * * @return the current status of the chronothermostat module * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException { try { @@ -194,8 +191,7 @@ public ModuleStatus getModuleStatus(String plantId, String moduleId) throws Smar * * @return {@code true} if the settings have been successfully applied, {@code false} otherwise * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public boolean setModuleStatus(ModuleSettings settings) throws SmartherGatewayException { // Prepare request payload @@ -252,8 +248,7 @@ public boolean setModuleStatus(ModuleSettings settings) throws SmartherGatewayEx * * @return the list of registered programs, or an empty {@link List} in case of no programs found * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public List getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException { try { @@ -274,8 +269,7 @@ public List getModulePrograms(String plantId, String moduleId) throws S * * @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public List getSubscriptions() throws SmartherGatewayException { try { @@ -306,8 +300,7 @@ public List getSubscriptions() throws SmartherGatewayException { * * @return the identifier this subscription has been registered under * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException { try { @@ -336,8 +329,7 @@ public String subscribePlant(String plantId, String notificationUrl) throws Smar * * @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise * - * @throws {@link SmartherGatewayException} - * in case of communication issues with the API gateway + * @throws SmartherGatewayException in case of communication issues with the API gateway */ public boolean unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException { final ContentResponse response = requestBasic(DELETE, String.format(PATH_UNSUBSCRIBE, plantId, subscriptionId)); diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApiConnector.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApiConnector.java index 6532aee7babca..8cb08201355c0 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApiConnector.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/SmartherApiConnector.java @@ -113,8 +113,7 @@ public SmartherApiConnector(ScheduledExecutorService scheduler, HttpClient httpC * * @return the raw response returned by the API gateway * - * @throws {@link SmartherGatewayException} - * if the call failed due to an issue with the API gateway + * @throws SmartherGatewayException if the call failed due to an issue with the API gateway */ public ContentResponse request(Function requester, String subscription, String authorization) throws SmartherGatewayException { diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Chronothermostat.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Chronothermostat.java index 266570e67e6f5..ec66ce9bd3a52 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Chronothermostat.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Chronothermostat.java @@ -104,8 +104,8 @@ public String getTemperatureFormat() { * * @return a {@link MeasureUnit} object representing the module operational temperature format * - * @throws {@link SmartherIllegalPropertyValueException} - * if the measure internal raw unit cannot be mapped to any valid measure unit + * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid + * measure unit */ public MeasureUnit getTemperatureFormatUnit() throws SmartherIllegalPropertyValueException { return MeasureUnit.fromValue(temperatureFormat); @@ -125,8 +125,8 @@ public String getLoadState() { * * @return {@code true} if the load state is active, {@code false} otherwise * - * @throws {@link SmartherIllegalPropertyValueException} - * if the load state internal raw value cannot be mapped to any valid load state enum value + * @throws SmartherIllegalPropertyValueException if the load state internal raw value cannot be mapped to any valid + * load state enum value */ public boolean isActive() throws SmartherIllegalPropertyValueException { return LoadState.fromValue(loadState).isActive(); diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Enums.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Enums.java index 6939da6f2461e..a421aef5017dd 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Enums.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Enums.java @@ -54,8 +54,7 @@ public String getValue() { * * @return the enum value representing the given raw value * - * @throws {@link SmartherIllegalPropertyValueException} - * if the raw value cannot be mapped to any valid enum value + * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value */ public static Function fromValue(String value) throws SmartherIllegalPropertyValueException { return lookup(Function.class, value); @@ -91,8 +90,7 @@ public String getValue() { * * @return the enum value representing the given raw value * - * @throws {@link SmartherIllegalPropertyValueException} - * if the raw value cannot be mapped to any valid enum value + * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value */ public static Mode fromValue(String value) throws SmartherIllegalPropertyValueException { return lookup(Mode.class, value); @@ -134,8 +132,7 @@ public boolean isActive() { * * @return the enum value representing the given raw value * - * @throws {@link SmartherIllegalPropertyValueException} - * if the raw value cannot be mapped to any valid enum value + * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value */ public static LoadState fromValue(String value) throws SmartherIllegalPropertyValueException { return lookup(LoadState.class, value); @@ -190,8 +187,7 @@ public static MeasureUnit fromUnit(Unit unit) { * * @return the enum value representing the given raw value * - * @throws {@link SmartherIllegalPropertyValueException} - * if the raw value cannot be mapped to any valid enum value + * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value */ public static MeasureUnit fromValue(String value) throws SmartherIllegalPropertyValueException { return lookup(MeasureUnit.class, value); @@ -225,8 +221,7 @@ public int getValue() { * * @return the enum value representing the given raw value * - * @throws {@link SmartherIllegalPropertyValueException} - * if the raw value cannot be mapped to any valid enum value + * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value */ public static BoostTime fromValue(int value) throws SmartherIllegalPropertyValueException { return lookup(BoostTime.class, value); diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Measure.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Measure.java index a5ef2d603f023..013052e8c43e5 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Measure.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Measure.java @@ -69,8 +69,8 @@ public String getUnit() { * * @return a {@link MeasureUnit} object representing the measure unit * - * @throws {@link SmartherIllegalPropertyValueException} - * if the measure internal raw unit cannot be mapped to any valid measure unit + * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid + * measure unit */ public MeasureUnit getMeasureUnit() throws SmartherIllegalPropertyValueException { return MeasureUnit.fromValue(unit); @@ -81,8 +81,8 @@ public MeasureUnit getMeasureUnit() throws SmartherIllegalPropertyValueException * * @return the value and measure unit * - * @throws {@link SmartherIllegalPropertyValueException} - * if the measure internal raw unit cannot be mapped to any valid measure unit + * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid + * measure unit */ public State toState() throws SmartherIllegalPropertyValueException { State state = UnDefType.UNDEF; diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Sensor.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Sensor.java index f37a4873e8dd7..7258110643c44 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Sensor.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/dto/Sensor.java @@ -54,8 +54,8 @@ public class Sensor { * * @return a {@link State} object representing the overall state of the sensor * - * @throws {@link SmartherIllegalPropertyValueException} - * if the sensor internal raw state cannot be mapped to any valid value + * @throws SmartherIllegalPropertyValueException if the sensor internal raw state cannot be mapped to any valid + * value */ public State toState() throws SmartherIllegalPropertyValueException { final Measure measure = getMeasure(0); diff --git a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/exception/SmartherNotificationException.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/exception/SmartherNotificationException.java index c46ab8cb5dd95..013ecff4d0c54 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/exception/SmartherNotificationException.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/api/exception/SmartherNotificationException.java @@ -39,7 +39,7 @@ public SmartherNotificationException(String message) { * * @param message * the error message returned from the API gateway - * @param cause + * @param exception * the cause (a null value is permitted, and indicates that the cause is nonexistent or unknown) */ public SmartherNotificationException(String message, Throwable exception) { 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 5cfb06bbdd5c7..8dc7b2040a2c6 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 @@ -42,8 +42,7 @@ public final class DateUtil { * * @return a {@link LocalDate} object containing the parsed date * - * @throws {@link DateTimeParseException} - * if the string cannot be parsed to a local date + * @throws DateTimeParseException if the string cannot be parsed to a local date */ public static LocalDate parseDate(@Nullable String str, String pattern) { if (str == null) { @@ -63,8 +62,7 @@ public static LocalDate parseDate(@Nullable String str, String pattern) { * * @return a {@link LocalDateTime} object containing the parsed date and time * - * @throws {@link DateTimeParseException} - * if the string cannot be parsed to a local date and time + * @throws DateTimeParseException if the string cannot be parsed to a local date and time */ public static LocalDateTime parseLocalTime(@Nullable String str, String pattern) { if (str == null) { @@ -84,8 +82,7 @@ public static LocalDateTime parseLocalTime(@Nullable String str, String pattern) * * @return a {@link ZonedDateTime} object containing the parsed date and time with timezone * - * @throws {@link DateTimeParseException} - * if the string cannot be parsed to a date and time with timezone + * @throws DateTimeParseException if the string cannot be parsed to a date and time with timezone */ public static ZonedDateTime parseZonedTime(@Nullable String str, String pattern) { if (str == null) { @@ -119,8 +116,7 @@ public static ZonedDateTime getZonedStartOfDay(int days, ZoneId zoneId) { * * @return a string representing the local date and time object * - * @throws {@link DateTimeException} - * if an error occurs during printing + * @throws DateTimeException if an error occurs during printing */ public static String format(LocalDateTime date, String pattern) { DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern); @@ -137,8 +133,7 @@ public static String format(LocalDateTime date, String pattern) { * * @return a string representing the date and time with timezone object * - * @throws {@link DateTimeException} - * if an error occurs during printing + * @throws DateTimeException if an error occurs during printing */ public static String format(ZonedDateTime date, String pattern) { DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern); @@ -158,8 +153,7 @@ public static String format(ZonedDateTime date, String pattern) { * * @return a string representing the range between the two local date and time objects * - * @throws {@link DateTimeException} - * if an error occurs during printing + * @throws DateTimeException if an error occurs during printing */ public static String formatRange(LocalDateTime date1, LocalDateTime date2, String pattern) { DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern); @@ -180,8 +174,7 @@ public static String formatRange(LocalDateTime date1, LocalDateTime date2, Strin * * @return a string representing the range between the two date and time with timezone objects * - * @throws {@link DateTimeException} - * if an error occurs during printing + * @throws DateTimeException 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.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/StringUtil.java b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/StringUtil.java index 64c1929b06a69..8a0af0103c900 100644 --- a/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/StringUtil.java +++ b/bundles/org.openhab.binding.bticinosmarther/src/main/java/org/openhab/binding/bticinosmarther/internal/util/StringUtil.java @@ -136,8 +136,7 @@ public static String defaultIfBlank(String str, String defaultStr) { * * @return the string read from stream * - * @throws {@link IOException} - * if an I/O error occurs + * @throws IOException if an I/O error occurs */ public static String streamToString(InputStream input) throws IOException { InputStreamReader reader = new InputStreamReader(input); @@ -162,8 +161,7 @@ public static String streamToString(InputStream input) throws IOException { * * @return the string read from stream * - * @throws {@link IOException} - * if an I/O error occurs + * @throws IOException if an I/O error occurs */ public static String readerToString(Reader reader) throws IOException { final StringWriter writer = new StringWriter(); diff --git a/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/CaddxCommunicator.java b/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/CaddxCommunicator.java index fd9b9253793cd..ce31f87887d90 100644 --- a/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/CaddxCommunicator.java +++ b/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/CaddxCommunicator.java @@ -316,7 +316,7 @@ private void messageDispatchLoop() { /** * Event handler to receive the data from the serial port * - * @param SerialPortEvent serialPortEvent The event that occurred on the serial port + * @param serialPortEvent The event that occurred on the serial port */ @Override public void serialEvent(@Nullable SerialPortEvent serialPortEvent) { diff --git a/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/handler/CaddxBaseThingHandler.java b/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/handler/CaddxBaseThingHandler.java index ec4963c013180..01fddec086fc4 100644 --- a/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/handler/CaddxBaseThingHandler.java +++ b/bundles/org.openhab.binding.caddx/src/main/java/org/openhab/binding/caddx/internal/handler/CaddxBaseThingHandler.java @@ -102,15 +102,14 @@ public void initialize() { * Method to Update a Channel * * @param channel - * @param state - * @param description + * @param data */ public abstract void updateChannel(ChannelUID channel, String data); /** * Receives Events from the bridge. * - * @param event. + * @param event * @param thing */ public abstract void caddxEventReceived(CaddxEvent event, Thing thing); diff --git a/bundles/org.openhab.binding.cbus/src/main/java/org/openhab/binding/cbus/CBusBindingConstants.java b/bundles/org.openhab.binding.cbus/src/main/java/org/openhab/binding/cbus/CBusBindingConstants.java index 935a32f5546c1..cf726ebae00c5 100644 --- a/bundles/org.openhab.binding.cbus/src/main/java/org/openhab/binding/cbus/CBusBindingConstants.java +++ b/bundles/org.openhab.binding.cbus/src/main/java/org/openhab/binding/cbus/CBusBindingConstants.java @@ -20,7 +20,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link CBusBinding} class defines common constants, which are + * The {@link CBusBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Scott Linton - Initial contribution diff --git a/bundles/org.openhab.binding.cm11a/src/main/java/org/openhab/binding/cm11a/internal/CM11ABindingConstants.java b/bundles/org.openhab.binding.cm11a/src/main/java/org/openhab/binding/cm11a/internal/CM11ABindingConstants.java index c272e805affbf..c303c631fa018 100644 --- a/bundles/org.openhab.binding.cm11a/src/main/java/org/openhab/binding/cm11a/internal/CM11ABindingConstants.java +++ b/bundles/org.openhab.binding.cm11a/src/main/java/org/openhab/binding/cm11a/internal/CM11ABindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link CM11ABinding} class defines common constants, which are + * The {@link CM11ABindingConstants} class defines common constants, which are * used across the whole binding. * * @author Bob Raker - Initial contribution diff --git a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirCommandType.java b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirCommandType.java index 0735c6f472abf..fe1d7afca8f9c 100644 --- a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirCommandType.java +++ b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirCommandType.java @@ -780,7 +780,7 @@ public int getReadReplyDataBits() { * * @param key * command key - * @param value + * @param command * new state * @return initialized ComfoAirCommand */ diff --git a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialConnector.java b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialConnector.java index 4faf375b2b3da..633c6cf8b7f00 100644 --- a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialConnector.java +++ b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialConnector.java @@ -68,7 +68,7 @@ public ComfoAirSerialConnector(final SerialPortManager serialPortManager, final /** * Open serial port. * - * @throws PortInUseException, UnsupportedCommOperationException, IOException + * @throws ComfoAirSerialException */ public void open() throws ComfoAirSerialException { logger.debug("open(): Opening ComfoAir connection"); diff --git a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialException.java b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialException.java index 1be18fad51d44..594fb7f709ef2 100644 --- a/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialException.java +++ b/bundles/org.openhab.binding.comfoair/src/main/java/org/openhab/binding/comfoair/internal/ComfoAirSerialException.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link ConnectException} is thrown on errors relating the serial connection. + * The {@link ComfoAirSerialException} is thrown on errors relating the serial connection. * * @author Hans Böhm - Initial contribution */ diff --git a/bundles/org.openhab.binding.coolmasternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java b/bundles/org.openhab.binding.coolmasternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java index ddefd3fcd6ec6..4e5bd096c4554 100644 --- a/bundles/org.openhab.binding.coolmasternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java +++ b/bundles/org.openhab.binding.coolmasternet/src/main/java/org/openhab/binding/coolmasternet/internal/ControllerHandler.java @@ -186,7 +186,7 @@ public boolean isConnected() { * This method automatically acquires a connection. * * @return the server response to the command (never empty) - * @throws {@link IOException} if communications failed with the server + * @throws IOException if communications failed with the server */ public String sendCommand(final String command) throws IOException { synchronized (socketLock) { diff --git a/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsCountryConfiguration.java b/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsCountryConfiguration.java index fda0b12d06b99..62eb57b6ff857 100644 --- a/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsCountryConfiguration.java +++ b/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsCountryConfiguration.java @@ -15,7 +15,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration for the {@link CoronaStatsCountryHandler} + * Configuration for the + * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsCountryHandler} * * @author Johannes Ott - Initial contribution */ diff --git a/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsWorldConfiguration.java b/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsWorldConfiguration.java index 3abf279965615..15b06a7f20bdf 100644 --- a/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsWorldConfiguration.java +++ b/bundles/org.openhab.binding.coronastats/src/main/java/org/openhab/binding/coronastats/internal/config/CoronaStatsWorldConfiguration.java @@ -15,7 +15,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration for the {@link CoronaStatsWorldHandler} + * Configuration for the + * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsWorldHandler} * * @author Johannes Ott - Initial contribution */ diff --git a/bundles/org.openhab.binding.dali/src/main/java/org/openhab/binding/dali/internal/handler/DaliDt8DeviceHandler.java b/bundles/org.openhab.binding.dali/src/main/java/org/openhab/binding/dali/internal/handler/DaliDt8DeviceHandler.java index 7b6df1616b1e4..5fa63001cb4cf 100644 --- a/bundles/org.openhab.binding.dali/src/main/java/org/openhab/binding/dali/internal/handler/DaliDt8DeviceHandler.java +++ b/bundles/org.openhab.binding.dali/src/main/java/org/openhab/binding/dali/internal/handler/DaliDt8DeviceHandler.java @@ -124,7 +124,6 @@ public void handleCommand(ChannelUID channelUID, Command command) { logger.warn("Error querying device status: {}", e.getMessage()); return null; }); - } else if (CHANNEL_COLOR.equals(channelUID.getId())) { DaliAddress address; if (THING_TYPE_DEVICE_DT8.equals(this.thing.getThingTypeUID())) { @@ -189,7 +188,6 @@ public void handleCommand(ChannelUID channelUID, Command command) { logger.warn("Error querying device status: {}", e.getMessage()); return null; }); - } else { super.handleCommand(channelUID, command); } diff --git a/bundles/org.openhab.binding.dbquery/src/main/java/org/openhab/binding/dbquery/internal/dbimpl/influx2/Influx2Database.java b/bundles/org.openhab.binding.dbquery/src/main/java/org/openhab/binding/dbquery/internal/dbimpl/influx2/Influx2Database.java index b9cfa6157f978..388aa630eee7f 100644 --- a/bundles/org.openhab.binding.dbquery/src/main/java/org/openhab/binding/dbquery/internal/dbimpl/influx2/Influx2Database.java +++ b/bundles/org.openhab.binding.dbquery/src/main/java/org/openhab/binding/dbquery/internal/dbimpl/influx2/Influx2Database.java @@ -82,7 +82,6 @@ public QueryFactory queryFactory() throws DatabaseException { public CompletableFuture executeQuery(Query query) { try { if (query instanceof Influx2QueryFactory.Influx2Query influxQuery) { - CompletableFuture asyncResult = new CompletableFuture<>(); List records = new ArrayList<>(); client.query(influxQuery.getQuery(), (cancellable, record) -> { // onNext diff --git a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/DenonMarantzBindingConstants.java b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/DenonMarantzBindingConstants.java index e77ff5bab06d7..70bd85fda4e86 100644 --- a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/DenonMarantzBindingConstants.java +++ b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/DenonMarantzBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.type.ChannelTypeUID; /** - * The {@link DenonMarantzBinding} class defines common constants, which are + * The {@link DenonMarantzBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Jan-Willem Veldhuis - Initial contribution 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 a444995f4ce53..2f3671cbbd544 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,7 +31,7 @@ * * chapter "1.2.7 TripLabel" in Technical Interface Description for external Developers * - * @see @see DB API + * @see See DB API * Marketplace * * @author Sönke Küper - Initial contribution. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java index 425772bcd3bec..39ccdbdf0431d 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/BridgeMDNSDiscoveryParticipant.java @@ -34,7 +34,7 @@ /** * The {@link BridgeMDNSDiscoveryParticipant} is responsible for discovering digitalSTROM-Server. It uses the central - * {@link MDNSDiscoveryService}. + * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java index b34efc2ae5516..4a2f33e03d4a5 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DeviceDiscoveryService.java @@ -39,7 +39,7 @@ * The {@link DeviceDiscoveryService} discovers all digitalSTROM-Devices, of one supported device-color-type. The * device-color-type has to be given to the {@link #DeviceDiscoveryService(BridgeHandler, ThingTypeUID)} as * {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at - * {@link DeviceHandler#SUPPORTED_THING_TYPES}. + * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler#SUPPORTED_THING_TYPES}. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -170,7 +170,8 @@ private ThingUID getThingUID(GeneralDeviceInformation device) { } /** - * Removes the {@link Thing} of the given {@link Device}. + * Removes the {@link org.openhab.core.thing.Thing} of the given + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}. * * @param device (must not be null) */ @@ -184,7 +185,8 @@ public void onDeviceRemoved(GeneralDeviceInformation device) { /** * Creates a {@link DiscoveryResult} for the given {@link Device}, if the {@link Device} is supported and the - * {@link Device#getOutputMode()} is unequal {@link OutputModeEnum#DISABLED}. + * {@link Device#getOutputMode()} is unequal + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#DISABLED}. * * @param device (must not be null) */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java index 5f761457a8e96..94c3a0a89bf19 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/DiscoveryServiceManager.java @@ -60,8 +60,9 @@ public class DiscoveryServiceManager /** * Creates a new {@link DiscoveryServiceManager} and generates automatically all {@link SceneDiscoveryService}s and - * {@link DeviceDiscoveryService}s for all supported {@link ThingType}s of the {@link DeviceHandler} and - * {@link SceneHandler}. + * {@link org.openhab.binding.digitalstrom.internal.discovery.DeviceDiscoveryService}s for all supported + * {@link org.openhab.core.thing.type.ThingType}s of the + * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler} and {@link SceneHandler}. * * @param bridgeHandler (must not be null) */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java index c4c4ddfd0a114..50b511c83df45 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/SceneDiscoveryService.java @@ -38,7 +38,8 @@ /** * The {@link SceneDiscoveryService} discovers all digitalSTROM-scene of one supported scene-type. The scene-type has to * be given to the {@link #SceneDiscoveryService(BridgeHandler, ThingTypeUID)} as - * {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at {@link SceneHandler#SUPPORTED_THING_TYPES} + * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID} + * can be found at {@link org.openhab.binding.digitalstrom.internal.handler.SceneHandler#SUPPORTED_THING_TYPES} * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java index 03b1472a365f7..1e0fd2c742f72 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/discovery/ZoneTemperatureControlDiscoveryService.java @@ -34,8 +34,10 @@ /** * The {@link ZoneTemperatureControlDiscoveryService} discovers all digitalSTROM zones which have temperature control * configured. The thing-type has to be given to the - * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as {@link ThingTypeUID}. The supported - * {@link ThingTypeUID} can be found at {@link ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES} + * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as + * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID} + * can be found at + * {@link org.openhab.binding.digitalstrom.internal.handler.ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES} * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java index e77719d6e8a7e..e6fd13ff06a19 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/SensorValues.java @@ -24,7 +24,8 @@ /** * The {@link SensorValues} acts as container for the digitalSTROM json-method getSensorValues. So the - * {@link SensorValues} contains all {@link CachedSensorValue}s of a zone. + * {@link SensorValues} contains all + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s of a zone. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java index 43b30eaec4cb1..ac13d2bda90f9 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlConfig.java @@ -119,7 +119,9 @@ private void init(JsonObject jObject) { } /** - * Returns the refenceZone, if control-mode is {@link ControlModes#ZONE_FOLLOWER}, otherwise null. + * Returns the refenceZone, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#ZONE_FOLLOWER}, otherwise + * null. * * @return the referenceZone */ @@ -128,7 +130,8 @@ public Integer getReferenceZone() { } /** - * Returns the ctrlOffset, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlOffset, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlOffset */ @@ -137,7 +140,8 @@ public Float getCtrlOffset() { } /** - * Returns the manualValue, if control-mode is {@link ControlModes#MANUAL}, otherwise null. + * Returns the manualValue, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#MANUAL}, otherwise null. * * @return the manualValue */ @@ -146,7 +150,8 @@ public Float getManualValue() { } /** - * Returns the emergencyValue, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the emergencyValue, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the emergencyValue */ @@ -155,7 +160,8 @@ public Float getEmergencyValue() { } /** - * Returns the ctrlKp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlKp, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlKp */ @@ -164,7 +170,8 @@ public Float getCtrlKp() { } /** - * Returns the ctrlTs, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlTs, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlTs */ @@ -173,7 +180,8 @@ public Float getCtrlTs() { } /** - * Returns the ctrlTi, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlTi, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlTi */ @@ -182,7 +190,8 @@ public Float getCtrlTi() { } /** - * Returns the ctrlKd, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlKd, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlKd */ @@ -191,7 +200,8 @@ public Float getCtrlKd() { } /** - * Returns the ctrlImin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlImin, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlImin */ @@ -200,7 +210,8 @@ public Float getCtrlImin() { } /** - * Returns the ctrlImax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlImax, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlImax */ @@ -209,7 +220,8 @@ public Float getCtrlImax() { } /** - * Returns the ctrlYmin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlYmin, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlYmin */ @@ -218,7 +230,8 @@ public Float getCtrlYmin() { } /** - * Returns the ctrlYmax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlYmax, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlYmax */ @@ -227,7 +240,8 @@ public Float getCtrlYmax() { } /** - * Returns the ctrlAntiWindUp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlAntiWindUp, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlAntiWindUp */ @@ -236,7 +250,8 @@ public Boolean getCtrlAntiWindUp() { } /** - * Returns the ctrlKeepFloorWarm, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null. + * Returns the ctrlKeepFloorWarm, if control-mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null. * * @return the ctrlKeepFloorWarm */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java index df91679def534..59006725127dc 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/TemperatureControlValues.java @@ -80,7 +80,7 @@ private void init(JsonObject jObject) { } /** - * @see TemperatureControlStatus#getControlDSUID() + * @see org.openhab.binding.digitalstrom.internal.lib.climate.jsonresponsecontainer.impl.TemperatureControlStatus#getControlDSUID() * @return the controlDSUID */ public String getControlDSUID() { @@ -88,7 +88,7 @@ public String getControlDSUID() { } /** - * @see TemperatureControlStatus#getIsConfigured() + * @see org.openhab.binding.digitalstrom.internal.lib.serverconnection.constants.JSONApiResponseKeysEnum#IS_CONFIGURED * @return the isConfigured */ public Boolean getIsConfigured() { diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java index 12d7eaa27cffd..b9280258ad9a3 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/climate/jsonresponsecontainer/impl/WeatherSensorData.java @@ -26,8 +26,9 @@ /** * The {@link WeatherSensorData} acts as container for the digitalSTROM json-method getSensorValues. The - * {@link WeatherSensorData} contains all {@link CachedSensorValue}s and weather service information of the - * digitalSTROM-server, if a weather service is set. + * {@link WeatherSensorData} contains all + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s and weather service + * information of the digitalSTROM-server, if a weather service is set. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/config/Config.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/config/Config.java index 2860854af50a2..20a8c4a4b7400 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/config/Config.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/config/Config.java @@ -27,7 +27,7 @@ public class Config { */ public static final String DEFAULT_APPLICATION_NAME = "openHAB"; /** - * Defines the used tread pool name to get a thread pool from {@link ThreadPoolManager}. + * Defines the used tread pool name to get a thread pool from {@link org.openhab.core.common.ThreadPoolManager}. */ public static final String THREADPOOL_NAME = "digitalSTROM"; @@ -110,7 +110,9 @@ public class Config { private int totalPowerUpdateInterval = DEFAULT_TOTAL_POWER_UPDATE_INTERVAL; /** - * Default time to wait between another {@link SensorJob} can be executed on a circuit. + * Default time to wait between another + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob} + * can be executed on a circuit. */ public static final int DEFAULT_SENSOR_READING_WAIT_TIME = 60000; private int sensorReadingWaitTime = DEFAULT_SENSOR_READING_WAIT_TIME; @@ -135,11 +137,13 @@ public class Config { // max sensor reading cyclic to wait /** - * The default factor to prioritize medium {@link SensorJob}s down. + * The default factor to prioritize medium + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down. */ public static final long DEFAULT_MEDIUM_PRIORITY_FACTOR = 5; /** - * The default factor to prioritize low {@link SensorJob}s down. + * The default factor to prioritize low + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down. */ public static final long DEFAULT_LOW_PRIORITY_FACTOR = 10; @@ -147,13 +151,16 @@ public class Config { private long lowPriorityFactor = DEFAULT_LOW_PRIORITY_FACTOR; /** - * Defines the event polling interval of the {@link EventListener} in milliseconds. + * Defines the event polling interval of the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener} in milliseconds. */ private int eventListenerRefreshinterval = DEFAULT_POLLING_FREQUENCY; /** - * The default max standby active power for a device. It's needed to set a {@link Device} with output mode - * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode. + * The default max standby active power for a device. It's needed to set a + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE} + * on if it isen't any more in standby mode. */ public static final int DEFAULT_STANDBY_ACTIVE_POWER = 2; @@ -350,7 +357,8 @@ public String getCert() { } /** - * Sets the SSL-Certificate of the server, will be set automatically by the {@link HttpTransportImpl} if no + * Sets the SSL-Certificate of the server, will be set automatically by the + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.impl.HttpTransportImpl} if no * SSL-Certification path is set. * * @param cert of the digitalSTROM-Server to set @@ -461,7 +469,9 @@ public void setTotalPowerUpdateInterval(int totalPowerUpdateInterval) { } /** - * Returns the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit. + * Returns the time in milliseconds to wait between another + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob} + * can be executed on a circuit. * * @return the sensor reading wait time in milliseconds */ @@ -470,7 +480,9 @@ public int getSensorReadingWaitTime() { } /** - * Sets the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit. + * Sets the time in milliseconds to wait between another + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob} + * can be executed on a circuit. * * @param sensorReadingWaitTime in milliseconds */ @@ -479,7 +491,9 @@ public void setSensorReadingWaitTime(int sensorReadingWaitTime) { } /** - * Returns the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down. + * Returns the factor to prioritize medium + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s + * in the {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down. * * @return the medium priority factor */ @@ -488,7 +502,9 @@ public long getMediumPriorityFactor() { } /** - * Sets the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down. + * Sets the factor to prioritize medium + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down. * * @param mediumPriorityFactor to set */ @@ -497,7 +513,9 @@ public void setMediumPriorityFactor(long mediumPriorityFactor) { } /** - * Returns the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor} down. + * Returns the factor to prioritize low + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down. * * @return the low priority factor */ @@ -506,7 +524,9 @@ public long getLowPriorityFactor() { } /** - * Sets the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor}down. + * Sets the factor to prioritize low + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}down. * * @param lowPriorityFactor to set */ @@ -515,7 +535,9 @@ public void setLowPriorityFactor(long lowPriorityFactor) { } /** - * Returns the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}. + * Returns the polling interval in milliseconds to poll the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}. * * @return the EventListener refresh interval in milliseconds */ @@ -524,7 +546,9 @@ public int getEventListenerRefreshinterval() { } /** - * Sets the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}. + * Sets the polling interval in milliseconds to poll the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}. * * @param eventListenerRefreshinterval to set */ @@ -533,8 +557,10 @@ public void setEventListenerRefreshinterval(int eventListenerRefreshinterval) { } /** - * Returns the max standby active power for a device. It's needed to set a {@link Device} with output mode - * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode. + * Returns the max standby active power for a device. It's needed to set a + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE} + * on if it isen't any more in standby mode. * * @return the standby active power */ @@ -543,8 +569,10 @@ public int getStandbyActivePower() { } /** - * Sets the max standby active power for a device. It's needed to set a {@link Device} with output mode - * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode. + * Sets the max standby active power for a device. It's needed to set a + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE} + * on if it isen't any more in standby mode. * * @param standbyActivePower to set */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java index 0005e50a047dc..af9adb1b21825 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java @@ -19,7 +19,8 @@ /** * The {@link EventHandler} can be implemented to get informed by {@link EventItem}'s through the {@link EventListener}. *
- * For that the {@link #getSupportetEvents()} and {@link #supportsEvent(String)} methods have to be implemented, so that + * For that the {@link #getSupportedEvents()} and + * {@link #supportsEvent(String)} methods have to be implemented, so that * the {@link EventListener} knows whitch events it has to subscribe at the digitalSTROM-server and which handler has * to be informed.
* The implementation of the {@link EventHandler} also has to be registered through diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java index 57a3bce4a8098..801b736579341 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java @@ -46,7 +46,8 @@ * {@link EventHandler} needs to be informed of another event-type, you can use the methods * {@link #addSubscribe(String)} or {@link #addSubscribeEvents(List)} to add more than one event-type. To remove a * subscribed event you can use the method {@link #removeSubscribe(String, String)}, you also have to change the return - * of the {@link EventHandler} methods {@link EventHandler#getSupportetEvents()} and + * of the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventHandler} methods + * {@link EventHandler#getSupportedEvents()} and * {@link EventHandler#supportsEvent(String)}. *
* To start and stop the listening you have to call the methods {@link #start()} and {@link #stop()}. diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java index dc2c685cb995b..65d71bf855f4c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java @@ -33,7 +33,7 @@ public interface EventItem { String getName(); /** - * Returns {@link HashMap} with the properties fiels of this {@link EventItem}. + * Returns {@link java.util.HashMap} with the properties fiels of this {@link EventItem}. * The key is an {@link EventResponseEnum} and represents the property name * and the value is the property value. * @@ -42,7 +42,7 @@ public interface EventItem { Map getProperties(); /** - * Returns {@link HashMap} with the source fields of this {@link EventItem}. + * Returns {@link java.util.HashMap} with the source fields of this {@link EventItem}. * The key is an {@link EventResponseEnum} and represents the property name * and the value is the property value. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java index f0b8aa49403f9..a6d88174ee4b3 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/DeviceStatusListener.java @@ -17,15 +17,21 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.ChangeableDeviceConfigEnum; /** - * The {@link DeviceStatusListener} is notified, if a {@link Device} status or configuration has changed, if a scene - * configuration is added to a {@link Device} or if a device has been added or removed. The {@link DeviceStatusListener} - * can be also registered by a {@link Circuit} to get informed by configuration or status changes. + * The {@link DeviceStatusListener} is notified, if a + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} status or configuration has changed, + * if a scene configuration is added to a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} + * or if a device has been added or removed. The {@link DeviceStatusListener} + * can be also registered by a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit} + * to get informed by configuration or status changes. *

* By implementation with the id {@link #DEVICE_DISCOVERY} this listener can be used as a device discovery to get - * informed, if a new {@link Device} or {@link Circuit} is added or removed from the digitalSTROM-System.
+ * informed, if a new {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} or + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit} is added or removed from the + * digitalSTROM-System.
* For that the {@link DeviceStatusListener} has to be registered on the - * {@link DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}. Then the {@link DeviceStatusListener} gets - * informed by the methods {@link #onDeviceAdded(Object)} and {@link #onDeviceRemoved(Object)}. + * {@link org.openhab.binding.digitalstrom.internal.lib.manager.DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}. + * Then the {@link DeviceStatusListener} gets informed by the methods {@link #onDeviceAdded(GeneralDeviceInformation)} + * and {@link #onDeviceRemoved(GeneralDeviceInformation)}. *

* * @author Michael Ochel - Initial contribution @@ -40,8 +46,9 @@ public interface DeviceStatusListener { static final String DEVICE_DISCOVERY = "DeviceDiscovery"; /** - * This method is called whenever the state of the {@link Device} has changed and passes the new device state as an - * {@link DeviceStateUpdate} object. + * This method is called whenever the state of the + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} has changed and passes the new + * device state as an {@link DeviceStateUpdate} object. * * @param deviceStateUpdate new device status */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java index e92ef47d775ab..6116d7585ad1c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java @@ -22,8 +22,9 @@ * By implementation with the id {@link #SCENE_DISCOVERY} this listener can be used as a scene discovery to get * informed, if a new {@link InternalScene}s is added or removed from the digitalSTROM-System.
* For that the {@link SceneStatusListener} has to be registered on the - * {@link SceneManager#registerSceneListener(SceneStatusListener)}. Then the {@link SceneStatusListener} gets - * informed by the methods {@link #onSceneAdded(InternalScene)} and {@link #onSceneRemoved(InternalScene)}. + * {@link org.openhab.binding.digitalstrom.internal.lib.manager.SceneManager#registerSceneListener(SceneStatusListener)}. + * Then the {@link SceneStatusListener} gets informed by the methods {@link #onSceneAdded(InternalScene)} and + * {@link #onSceneRemoved(InternalScene)}. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SystemStateChangeListener.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SystemStateChangeListener.java index 9a686ce4f736a..9034f8dca7a84 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SystemStateChangeListener.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SystemStateChangeListener.java @@ -14,7 +14,9 @@ /** * The {@link SystemStateChangeListener} can be implemented to get informed by digitalSTROM system state changes. It - * has to be registered by supported classes, e.g. the {@link TemperatureControlManager} or self implemented classes. + * has to be registered by supported classes, e.g. the + * {@link org.openhab.binding.digitalstrom.internal.lib.manager.impl.TemperatureControlManager} + * or self implemented classes. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java index ac6a25c6822d2..7a8f0e53289b9 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/DeviceStatusManager.java @@ -30,10 +30,13 @@ * The {@link DeviceStatusManager} is responsible for the synchronization between the internal model of the * digitalSTROM-devices and the real existing digitalSTROM-devices. You can change the state of a device by sending a * direct command to the devices or by calling a scene. Furthermore the {@link DeviceStatusManager} get informed over - * the {@link SceneManager} by the {@link EventListener} if scenes are called by external sources. All + * the {@link SceneManager} by the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener} + * if scenes are called by external sources. All * configurations of the physically device will be synchronized to the internally managed model and updated as required. - * The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the {@link SensorJobExecutor} and - * {@link SceneReadingJobExecutor} to update required sensor and scene data. + * The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} to update required + * sensor and scene data. * *

* Therefore the {@link DeviceStatusManager} uses the {@link StructureManager} for the internal management of the @@ -67,14 +70,18 @@ public interface DeviceStatusManager extends EventHandler { /** - * Starts the working process for device synchronization. It also starts the {@link SensorJobExecutor} and the - * {@link SceneReadingJobExecutor} and the {@link SceneManager}. + * Starts the working process for device synchronization. It also starts the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} + * and the {@link SceneManager}. */ void start(); /** - * Stops the working process for device synchronization. It also stops the {@link SensorJobExecutor} and the - * {@link SceneReadingJobExecutor} and the {@link SceneManager}. + * Stops the working process for device synchronization. It also stops the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} and the + * {@link SceneManager}. */ void stop(); @@ -119,7 +126,8 @@ public interface DeviceStatusManager extends EventHandler { void updateSensorData(SensorJob sensorJob, String priority); /** - * This method adds a {@link SensorJob} with the appropriate priority to the {@link SceneReadingJobExecutor}. + * This method adds a {@link SensorJob} with the appropriate priority to the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor}. * * @param device device which will update scene data * @param deviceStateUpdate scene data to update diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java index 1d7c6bb05db34..e749ebc210808 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java @@ -36,8 +36,8 @@ * , {@link #callDeviceScene(String, Short)} etc. can be used. * *

- * If you call the {@link #start()} method an {@link EventListener} will be started to handle scene calls and undos from - * the outside. + * If you call the {@link #start()} method an {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener} + * will be started to handle scene calls and undos from the outside. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -131,7 +131,8 @@ public interface SceneManager extends EventHandler { void addInternalScene(InternalScene intScene); /** - * Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the {@link EventItem}. + * Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}. * * @param dSID of the {@link Device} that will be ignored * @param sceneId of the scene that will be ignored @@ -139,7 +140,8 @@ public interface SceneManager extends EventHandler { void addEcho(String dSID, short sceneId); /** - * Adds the scene call with the given internal scene id as an echo to ignore them by detecting the {@link EventItem} + * Adds the scene call with the given internal scene id as an echo to ignore them by detecting the + * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem} * . * * @param internalSceneID to ignore @@ -167,7 +169,8 @@ public interface SceneManager extends EventHandler { void generateScenes(); /** - * Will be called from the {@link SceneDiscovery}, if a scene type is generated or is fail.
+ * Will be called from the {@link org.openhab.binding.digitalstrom.internal.lib.structure.scene.SceneDiscovery}, + * if a scene type is generated or is fail.
* For that the scenesGenerated char array has four chars. Each char represents one scene type in the following * direction: *

    @@ -191,12 +194,12 @@ public interface SceneManager extends EventHandler { boolean isDiscoveryRegistrated(); /** - * Starts the {@link EventListener}. + * Starts the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}. */ void start(); /** - * Stops the {@link EventListener}. + * Stops the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}. */ void stop(); diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java index 7faab1044981a..2182b9d82ed8c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java @@ -71,8 +71,9 @@ public short getGroupID(String groupName) { } /** - * Query to get all zone and group names. Can be executed with {@link DsAPI#query(String, String)} or - * {@link DsAPI#query2(String, String)}. + * Query to get all zone and group names. Can be executed with + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query(String, String)} or + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query2(String, String)}. */ public static final String ZONE_GROUP_NAMES = "/apartment/zones/*(ZoneID,name)/groups/*(group,name)"; diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/CircuitScheduler.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/CircuitScheduler.java index 32cc4388492c9..85ea00c7e4632 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/CircuitScheduler.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/CircuitScheduler.java @@ -156,7 +156,9 @@ public Long getNextExecutionDelay() { } /** - * Removes all {@link SensorJob} of a specific {@link Device} with the given {@link DSID}. + * Removes all {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob} + * of a specific {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with the + * given {@link DSID}. * * @param dSID of the device */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SceneReadingJobExecutor.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SceneReadingJobExecutor.java index 8d23aac767e0e..c13d3742458a7 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SceneReadingJobExecutor.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SceneReadingJobExecutor.java @@ -19,8 +19,9 @@ /** * The {@link SceneReadingJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute - * digitalSTROM-Device scene configuration {@link SensorJob}'s e.g. {@link SceneConfigReadingJob} and - * {@link SceneOutputValueReadingJob}. + * digitalSTROM-Device scene configuration {@link SensorJob}'s e.g. + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneConfigReadingJob} and + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneOutputValueReadingJob}. *

    * In addition priorities can be assigned to jobs therefore the {@link SceneReadingJobExecutor} offers the methods * {@link #addHighPriorityJob(SensorJob)}, {@link #addMediumPriorityJob(SensorJob)} and diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SensorJobExecutor.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SensorJobExecutor.java index 22dcb158eb413..31a70b45ac95e 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SensorJobExecutor.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/SensorJobExecutor.java @@ -19,15 +19,18 @@ /** * The {@link SensorJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute - * digitalSTROM-Device {@link SensorJob}'s e.g. {@link DeviceConsumptionSensorJob} and - * {@link DeviceOutputValueSensorJob}. + * digitalSTROM-Device {@link SensorJob}'s e.g. + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob} and + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceOutputValueSensorJob}. *

    * In addition priorities can be assigned to jobs, but the following list shows the maximum evaluation of a * {@link SensorJob} per priority. *

    *
      - *
    • low priority: read cycles before execution is set in {@link Config}
    • - *
    • medium priority: read cycles before execution is set in {@link Config}
    • + *
    • low priority: read cycles before execution is set in + * {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}
    • + *
    • medium priority: read cycles before execution is set in + * {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}
    • *
    • high priority: read cycles before execution 0
    • *
    * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/sensorjob/SensorJob.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/sensorjob/SensorJob.java index 84260b1e5d782..fa7b35fd6db03 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/sensorjob/SensorJob.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/sensorjobexecutor/sensorjob/SensorJob.java @@ -18,8 +18,10 @@ /** * The {@link SensorJob} represents an executable job to read out digitalSTROM-Sensors or device configurations like * scene values.
    - * It can be added to an implementation of the {@link AbstractSensorJobExecutor} e.g. {@link SceneReadingJobExecutor} or - * {@link SensorJobExecutor}. + * It can be added to an implementation of the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.AbstractSensorJobExecutor} e.g. + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} or + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -27,7 +29,8 @@ public interface SensorJob { /** - * Returns the dSID of the {@link Device} for which this job is to be created. + * Returns the dSID of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} + * for which this job is to be created. * * @return dSID from the device */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java index 7538b98622211..2ea5e9ad25ab3 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java @@ -737,12 +737,17 @@ boolean setZoneTemperatureControlConfig(String sessionToken, Integer zoneID, Str boolean setZoneTemperatureControlState(String sessionToken, Integer zoneID, String zoneName, String controlState); /** - * Sets the wished temperature (control mode = {@link ControlModes#PID_CONTROL}) or control valve value for a - * operation mode, see - * {@link OperationModes}.
    + * Sets the wished temperature (control mode = + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}) or control + * valve value for a + * operation mode, see {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes}.
    * To set the values a {@link List} with an object array has to be set as controlVlaues parameter. The 1th field has - * to be a {@link String} for the {@link OperationModes} name and the 2nd field has to be an {@link Integer} for the - * new value. If the control mode is {@link ControlModes#PID_CONTROL} it is the nominal temperature, otherwise it is + * to be a {@link String} for the + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes} + * name and the 2nd field has to be an {@link Integer} for the + * new value. If the control mode is + * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL} it is the + * nominal temperature, otherwise it is * the control valve value. * * @param sessionToken can be null, if a diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java index 306853e73ff32..dbd0a0afb445c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/HttpTransportImpl.java @@ -67,8 +67,8 @@ *

    *

    * If a {@link ConnectionManager} is given at the constructor, the session-token is not needed by requests and the - * {@link ConnectionListener}, which is registered at the {@link ConnectionManager}, will be automatically informed - * about + * {@link org.openhab.binding.digitalstrom.internal.lib.listener.ConnectionListener}, which is registered at the + * {@link ConnectionManager}, will be automatically informed about * connection state changes through the {@link #execute(String, int, int)} method. *

    * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/SimpleRequestBuilder.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/SimpleRequestBuilder.java index 962868bbabdce..e4ac5bd6e73f4 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/SimpleRequestBuilder.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/SimpleRequestBuilder.java @@ -58,7 +58,6 @@ private SimpleRequestBuilder() { * * @param interfaceKey must not be null * @return simpleRequestBuilder with chosen interface - * @throws NullArgumentException if the interfaceKey is null */ public static SimpleRequestBuilder buildNewRequest(String interfaceKey) throws IllegalArgumentException { if (builder == null) { @@ -75,7 +74,6 @@ public static SimpleRequestBuilder buildNewRequest(String interfaceKey) throws I * @param requestClassKey must not be null * @return simpleRequestBuilder with chosen requestClass * @throws IllegalArgumentException if a requestClass is already chosen - * @throws NullArgumentException if the requestClassKey is null */ public static SimpleRequestBuilder buildNewJsonRequest(String requestClassKey) throws IllegalArgumentException { return buildNewRequest(InterfaceKeys.JSON).addRequestClass(requestClassKey); @@ -98,7 +96,6 @@ private SimpleRequestBuilder buildNewRequestInt(String interfaceKey) { * @param requestClassKey must not be null * @return simpleRequestBuilder with chosen requestClass * @throws IllegalArgumentException if a requestClass is already chosen - * @throws NullArgumentException if the requestClassKey is null */ public SimpleRequestBuilder addRequestClass(String requestClassKey) throws IllegalArgumentException { return builder.addRequestClassInt(requestClassKey); @@ -124,7 +121,6 @@ private SimpleRequestBuilder addRequestClassInt(String requestClassKey) { * @param functionKey must not be null * @return SimpleRequestBuilder with chosen function * @throws IllegalArgumentException if a function is already chosen - * @throws NullArgumentException if the functionKey is null */ public SimpleRequestBuilder addFunction(String functionKey) throws IllegalArgumentException { return builder.addFunctionInt(functionKey); @@ -154,7 +150,6 @@ private SimpleRequestBuilder addFunctionInt(String functionKey) { * @param parameterValue can be null * @return SimpleRequestBuilder with added parameter * @throws IllegalArgumentException if no class and function added - * @throws NullArgumentException if the parameterKey is null */ public SimpleRequestBuilder addParameter(String parameterKey, String parameterValue) throws IllegalArgumentException { @@ -169,7 +164,6 @@ public SimpleRequestBuilder addParameter(String parameterKey, String parameterVa * @param zoneName * @return SimpleRequestBuilder with added parameter * @throws IllegalArgumentException if no class and function added - * @throws NullArgumentException if the parameterKey is null */ public SimpleRequestBuilder addDefaultZoneParameter(String sessionToken, Integer zoneID, String zoneName) throws IllegalArgumentException { @@ -185,7 +179,6 @@ public SimpleRequestBuilder addDefaultZoneParameter(String sessionToken, Integer * @param groupName * @return SimpleRequestBuilder with added parameter * @throws IllegalArgumentException if no class and function added - * @throws NullArgumentException if the parameterKey is null */ public SimpleRequestBuilder addDefaultGroupParameter(String sessionToken, Short groupID, String groupName) throws IllegalArgumentException { @@ -204,7 +197,6 @@ public SimpleRequestBuilder addDefaultGroupParameter(String sessionToken, Short * @param groupName * @return SimpleRequestBuilder with added parameter * @throws IllegalArgumentException if no class and function added - * @throws NullArgumentException if the parameterKey is null */ public SimpleRequestBuilder addDefaultZoneGroupParameter(String sessionToken, Integer zoneID, String zoneName, Short groupID, String groupName) throws IllegalArgumentException { @@ -222,7 +214,6 @@ public SimpleRequestBuilder addDefaultZoneGroupParameter(String sessionToken, In * @param name * @return SimpleRequestBuilder with added parameter * @throws IllegalArgumentException if no class and function added - * @throws NullArgumentException if the parameterKey is null */ public SimpleRequestBuilder addDefaultDeviceParameter(String sessionToken, DSID dsid, String dSUID, String name) throws IllegalArgumentException { diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/constants/ExeptionConstants.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/constants/ExeptionConstants.java index 16267ac6290d6..4922895df416a 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/constants/ExeptionConstants.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/simpledsrequestbuilder/constants/ExeptionConstants.java @@ -13,7 +13,11 @@ package org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants; /** - * The {@link ExeptionConstants} contains the {@link SimpleRequestBuilder} exception strings. + * The + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants.ExeptionConstants} + * contains the + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.SimpleRequestBuilder} + * exception strings. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/AbstractGeneralDeviceInformations.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/AbstractGeneralDeviceInformations.java index 5e7c222173b78..641df6fd5d6d6 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/AbstractGeneralDeviceInformations.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/AbstractGeneralDeviceInformations.java @@ -20,7 +20,7 @@ import com.google.gson.JsonObject; /** - * The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformations} and + * The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformation}s and * can be implement by subclasses which contains the same device informations like dSID and/or mechanismen like the * {@link DeviceStatusListener}. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Circuit.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Circuit.java index eae7516a1e52b..8aa662839b7ac 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Circuit.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Circuit.java @@ -21,8 +21,9 @@ /** * The {@link Circuit} represents a circuit of the digitalStrom system. For that all information will be able to get and * set through the same named getter- and setter-methods. To get informed about status and configuration changes a - * {@link DeviceStatusListener} can be registered. For that and to get the general device informations like the dSID the - * {@link Circuit} implements the {@link GeneralDeviceInformations} interface. + * {@link org.openhab.binding.digitalstrom.internal.lib.listener.DeviceStatusListener} can be registered. For that and + * to get the general device informations like the dSID the {@link Circuit} implements the + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s interface. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java index 6ecd3c0502fef..a974ff160ef71 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java @@ -130,7 +130,7 @@ public interface Device extends GeneralDeviceInformation { /** * Returns the current functional color group of this device. - * For more informations please have a look at {@link FunctionalColorGroupEnum}. + * For more informations please have a look at {@link ApplicationGroup}. * * @return current functional color group */ @@ -519,7 +519,7 @@ void setSensorDataRefreshPriority(String powerConsumptionRefreshPriority, String /** * Returns true, if this {@link Device} is a heating device. That means, that the output mode of this {@link Device} * is one of the following modes {@link OutputModeEnum#PWM} or {@link OutputModeEnum#SWITCH} and the - * {@link FuncNameAndColorGroupEnum} is {@link FuncNameAndColorGroupEnum#HEATING}. + * {@link ApplicationGroup} is {@link ApplicationGroup#HEATING}. * * @return true, if it is a heating device */ @@ -745,7 +745,9 @@ void setSensorDataRefreshPriority(String powerConsumptionRefreshPriority, String boolean hasPowerSensors(); /** - * Only needed for {@link DeviceConsumptionSensorJob}'s. To set the internal digitalSTROM sensor value please use + * Only needed for + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob}'s. + * To set the internal digitalSTROM sensor value please use * {@link #setDsSensorValue(SensorEnum, Integer)}. * * @param sensorType of the sensor @@ -754,12 +756,14 @@ void setSensorDataRefreshPriority(String powerConsumptionRefreshPriority, String void setDeviceSensorDsValueBySensorJob(SensorEnum sensorType, Integer value); /** - * Enables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events. + * Enables the internal sensor echo box for + * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events. */ void enableSensorEchoBox(); /** - * Disables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events. + * Disables the internal sensor echo box for + * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events. */ void disableSensorEchoBox(); @@ -771,8 +775,9 @@ void setSensorDataRefreshPriority(String powerConsumptionRefreshPriority, String boolean isSensorEchoBoxEnabled(); /** - * Sets the {@link DeviceSensorValue} through an {@link EventItem} of the type - * {@link EventNames#DEVICE_SENSOR_VALUE}. + * Sets the {@link DeviceSensorValue} through an + * {@link EventItem} of the type + * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE}. * * @param event of the sensor update */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/GeneralDeviceInformation.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/GeneralDeviceInformation.java index 68e8dbe1e8232..ba66ddf80d85c 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/GeneralDeviceInformation.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/GeneralDeviceInformation.java @@ -16,7 +16,7 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.impl.DSID; /** - * The {@link GeneralDeviceInformations} interface contains all informations of digitalSTROM devices, which are + * The {@link GeneralDeviceInformation} interface contains all informations of digitalSTROM devices, which are * identical for all device types. It also contains the methods to implement the mechanism of the * {@link DeviceStatusListener}. * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java index 7a0c00ea4a803..1a453a5435588 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/DeviceStateUpdate.java @@ -81,7 +81,9 @@ public interface DeviceStateUpdate { *
  • For SceneCall-type the value is between 0 and 127.
  • *
  • For all SceneUndo-types the value is the new output value.
  • *
  • For all SensorUpdate-types will read the sensor data directly, if the value is 0, otherwise a - * {@link SensorJob} will be added to the {@link SensorJobExecutor}.
  • + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob} + * will be added to the + * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}. *
* * @return new state value diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java index 7c61b2b5e68c6..3f084f5eaca54 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceBinaryInput.java @@ -18,7 +18,8 @@ /** * The {@link DeviceBinaryInput} contains all information of a device binary input, e.g. binary input type id (see - * {@link DeviceBinarayInputEnum}, state and so on. + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}, + * state and so on. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -33,8 +34,11 @@ public class DeviceBinaryInput { private Short stateValue; /** - * Creates a new {@link DeviceBinarayInputEnum} through the {@link JsonObject} of the binary inputs at json response - * from digitalSTROM JSON-API or property-tree. Will be automatically added to a {@link DeviceImpl}, if binary + * Creates a new + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum} + * through the {@link JsonObject} of the binary inputs at json response + * from digitalSTROM JSON-API or property-tree. Will be automatically added to a + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl}, if binary * inputs exists. * * @param jsonObject must not be null @@ -108,7 +112,7 @@ public Short getTargetGroup() { /** * Returns the input type id of this {@link DeviceBinaryInput}. Available input types see - * {@link DeviceBinarayInputEnum}. + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}. * * @return the inputType */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java index 1cd6f03159bde..fb00716fc5946 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/deviceparameters/impl/DeviceSensorValue.java @@ -30,9 +30,9 @@ /** * The {@link DeviceSensorValue} contains all needed information of a device sensor, e.g. the sensor type, to detect * which kind of sensor it is (see {@link SensorEnum}), the sensor index to read out sensor at the digitalSTROM device - * by calling {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)} and as well as of course the value - * and - * timestamp of the last sensor update. + * by calling + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)} + * and as well as of course the value and timestamp of the last sensor update. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -85,7 +85,7 @@ public DeviceSensorValue(JsonObject sensorValue) { /** * Creates a new {@link DeviceSensorValue} through the properties of a digitalSTROM - * {@link EventNames#DEVICE_SENSOR_VALUE} event. + * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} event. * * @param eventProperties must not be null */ @@ -212,7 +212,7 @@ public SensorEnum getSensorType() { /** * Returns the sensor index to read the sensor value out though - * {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}. + * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}. * * @return the sensorIndex */ diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/util/DSJsonParser.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/util/DSJsonParser.java index 0cd5bef636eb1..150f0a72c25c3 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/util/DSJsonParser.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/util/DSJsonParser.java @@ -25,7 +25,8 @@ import com.google.gson.JsonObject; /** - * digitalSTROM JSON Parser class. Externalizes code from {@link DeviceImpl} + * digitalSTROM JSON Parser class. Externalizes code from + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl} * * @author Rouven Schürch - Initial contribution * diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsChannelTypeProvider.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsChannelTypeProvider.java index a38f7e6ec190b..2e3cb453f6e60 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsChannelTypeProvider.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsChannelTypeProvider.java @@ -48,7 +48,7 @@ /** * The {@link DsChannelTypeProvider} implements the {@link ChannelTypeProvider} - * generates all supported {@link Channel}'s for digitalSTROM. + * generates all supported {@link org.openhab.core.thing.Channel}'s for digitalSTROM. * * @author Michael Ochel - Initial contribution * @author Matthias Siegele - Initial contribution @@ -118,8 +118,8 @@ public class DsChannelTypeProvider extends BaseDsI18n implements ChannelTypeProv * channel type exists for the given {@link ApplicationGroup.Color} and * {@link OutputModeEnum}. * - * @param functionalGroup of the {@link Device} - * @param outputMode of the {@link Device} + * @param functionalGroup of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} + * @param outputMode of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} * @return the output channel type id or null */ public static String getOutputChannelTypeID(ApplicationGroup.Color functionalGroup, OutputModeEnum outputMode, @@ -541,7 +541,7 @@ public ChannelType getChannelType(ChannelTypeUID channelTypeUID, Locale locale) } /** - * Returns the {@link ChannelGroupTypeUID} for the given {@link SensorEnum}. + * Returns the {@link ChannelTypeUID} for the given {@link SensorEnum}. * * @param sensorType (must not be null) * @return the channel type uid @@ -551,7 +551,7 @@ public static ChannelTypeUID getSensorChannelUID(SensorEnum sensorType) { } /** - * Returns the {@link ChannelGroupTypeUID} for the given + * Returns the {@link ChannelTypeUID} for the given * {@link DeviceBinarayInputEnum}. * * @param binaryInputType (must not be null) diff --git a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsDeviceThingTypeProvider.java b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsDeviceThingTypeProvider.java index 864bb442026bb..5d2a33fbad3b9 100644 --- a/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsDeviceThingTypeProvider.java +++ b/bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/providers/DsDeviceThingTypeProvider.java @@ -44,7 +44,8 @@ /** * The {@link DsDeviceThingTypeProvider} creates the {@link ThingType}'s for the subclasses of the - * {@link GeneralDeviceInformations}. It also adds the {@link ThingTypeUID}'s to the related handlers. So only the + * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s. + * It also adds the {@link ThingTypeUID}'s to the related handlers. So only the * {@link SupportedThingTypes} enum has to be adjusted, if new device types of digitalSTROM should be supported. * Provided the new digitalSTROM devices uses the same mechanism like now. * diff --git a/bundles/org.openhab.binding.dominoswiss/src/main/java/org/openhab/binding/dominoswiss/internal/EGateHandler.java b/bundles/org.openhab.binding.dominoswiss/src/main/java/org/openhab/binding/dominoswiss/internal/EGateHandler.java index 22fe875c8f71d..3699b99fbb0e0 100644 --- a/bundles/org.openhab.binding.dominoswiss/src/main/java/org/openhab/binding/dominoswiss/internal/EGateHandler.java +++ b/bundles/org.openhab.binding.dominoswiss/src/main/java/org/openhab/binding/dominoswiss/internal/EGateHandler.java @@ -42,7 +42,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link EgateHandler} is responsible for handling commands, which are + * The {@link EGateHandler} is responsible for handling commands, which are * sent to one of the channels. * * @author Frieso Aeschbacher - Initial contribution @@ -274,7 +274,6 @@ private void pollingConfig() { private void startAutomaticRefresh() { Runnable runnable = () -> { try { - Socket localSocket = egateSocket; if (localSocket == null) { return; diff --git a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/audio/ConvertedInputStream.java b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/audio/ConvertedInputStream.java index e4ac1604bb185..8c8a09db44564 100644 --- a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/audio/ConvertedInputStream.java +++ b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/audio/ConvertedInputStream.java @@ -42,7 +42,6 @@ public class ConvertedInputStream extends InputStream { private AudioInputStream pcmUlawInputStream; public ConvertedInputStream(InputStream innerInputStream) throws UnsupportedAudioFileException, IOException { - pcmUlawInputStream = getULAWStream(new BufferedInputStream(innerInputStream)); } @@ -96,7 +95,6 @@ public void close() throws IOException { */ private AudioInputStream getULAWStream(InputStream originalInputStream) throws UnsupportedAudioFileException, IOException { - try { AudioInputStream audioInputStream = AudioSystem.getAudioInputStream(originalInputStream); AudioFormat format = audioInputStream.getFormat(); diff --git a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/ControllerConfiguration.java b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/ControllerConfiguration.java index 16cc0824b2749..0486c67a27d8b 100644 --- a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/ControllerConfiguration.java +++ b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/ControllerConfiguration.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link DoorbirdConfig} class contains fields mapping thing configuration parameters + * The {@link ControllerConfiguration} class contains fields mapping thing configuration parameters * for the Doorbird A1081 Controller.. * * @author Mark Hilbush - Initial contribution diff --git a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/DoorbellConfiguration.java b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/DoorbellConfiguration.java index 71498b2c04de5..89c4f99484f0d 100644 --- a/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/DoorbellConfiguration.java +++ b/bundles/org.openhab.binding.doorbird/src/main/java/org/openhab/binding/doorbird/internal/config/DoorbellConfiguration.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link DoorbellConfig} class contains fields mapping thing configuration parameters + * The {@link DoorbellConfiguration} class contains fields mapping thing configuration parameters * for doorbell thing types. * * @author Mark Hilbush - Initial contribution diff --git a/bundles/org.openhab.binding.draytonwiser/src/main/java/org/openhab/binding/draytonwiser/internal/discovery/DraytonWiserMDNSDiscoveryParticipant.java b/bundles/org.openhab.binding.draytonwiser/src/main/java/org/openhab/binding/draytonwiser/internal/discovery/DraytonWiserMDNSDiscoveryParticipant.java index 720f34189b3f6..dbf409cd16d7f 100644 --- a/bundles/org.openhab.binding.draytonwiser/src/main/java/org/openhab/binding/draytonwiser/internal/discovery/DraytonWiserMDNSDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.draytonwiser/src/main/java/org/openhab/binding/draytonwiser/internal/discovery/DraytonWiserMDNSDiscoveryParticipant.java @@ -75,7 +75,6 @@ public String getServiceType() { .withRepresentationProperty(PROP_ADDRESS).withLabel("Heat Hub - " + service.getName()) .build(); } - } } return null; diff --git a/bundles/org.openhab.binding.dscalarm/src/main/java/org/openhab/binding/dscalarm/internal/handler/DSCAlarmBaseThingHandler.java b/bundles/org.openhab.binding.dscalarm/src/main/java/org/openhab/binding/dscalarm/internal/handler/DSCAlarmBaseThingHandler.java index 83a960670cef3..5d09b5f459755 100644 --- a/bundles/org.openhab.binding.dscalarm/src/main/java/org/openhab/binding/dscalarm/internal/handler/DSCAlarmBaseThingHandler.java +++ b/bundles/org.openhab.binding.dscalarm/src/main/java/org/openhab/binding/dscalarm/internal/handler/DSCAlarmBaseThingHandler.java @@ -343,7 +343,7 @@ public boolean isThingHandlerInitialized() { /** * Set Thing Handler refresh status. * - * @param deviceInitialized + * @param refreshed */ public void setThingHandlerInitialized(boolean refreshed) { this.thingHandlerInitialized = refreshed; diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/DSMRTelegramListener.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/DSMRTelegramListener.java index 16a3acc4816c7..437371cb88f7c 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/DSMRTelegramListener.java +++ b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/device/DSMRTelegramListener.java @@ -42,8 +42,6 @@ public class DSMRTelegramListener implements P1TelegramListener, DSMRConnectorLi /** * Constructor. - * - * @param eventListener listener to send received errors or messages to */ public DSMRTelegramListener() { parser = new P1TelegramParser(this); diff --git a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRMeterDiscoveryService.java b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRMeterDiscoveryService.java index 0db8a986fc30f..4c6796ff65fa7 100644 --- a/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRMeterDiscoveryService.java +++ b/bundles/org.openhab.binding.dsmr/src/main/java/org/openhab/binding/dsmr/internal/discovery/DSMRMeterDiscoveryService.java @@ -55,8 +55,6 @@ public class DSMRMeterDiscoveryService extends DSMRDiscoveryService implements P /** * Constructs a new {@link DSMRMeterDiscoveryService} attached to the give bridge handler. - * - * @param dsmrBridgeHandler The bridge handler this discovery service is attached to */ public DSMRMeterDiscoveryService() { super(); diff --git a/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugRegionConfiguration.java b/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugRegionConfiguration.java index efc41be50d289..9b9aa7b8919ac 100644 --- a/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugRegionConfiguration.java +++ b/bundles/org.openhab.binding.dwdpollenflug/src/main/java/org/openhab/binding/dwdpollenflug/internal/config/DWDPollenflugRegionConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration for the {@link DWDPollenflugRegionHandler} + * Configuration for the {@link org.openhab.binding.dwdpollenflug.internal.handler.DWDPollenflugRegionHandler} * * @author Johannes Ott - Initial contribution */ diff --git a/bundles/org.openhab.binding.dwdunwetter/src/main/java/org/openhab/binding/dwdunwetter/internal/dto/DwdWarningCache.java b/bundles/org.openhab.binding.dwdunwetter/src/main/java/org/openhab/binding/dwdunwetter/internal/dto/DwdWarningCache.java index 6db2e0db73cd8..4c4850ffec07e 100644 --- a/bundles/org.openhab.binding.dwdunwetter/src/main/java/org/openhab/binding/dwdunwetter/internal/dto/DwdWarningCache.java +++ b/bundles/org.openhab.binding.dwdunwetter/src/main/java/org/openhab/binding/dwdunwetter/internal/dto/DwdWarningCache.java @@ -21,8 +21,9 @@ import java.util.stream.Collectors; /** - * Cache of Warnings to update the {@link DwdUnwetterBindingConstants#CHANNEL_UPDATED} if a new warning is sent to a - * channel. + * Cache of Warnings to update the + * {@link org.openhab.binding.dwdunwetter.internal.DwdUnwetterBindingConstants#CHANNEL_UPDATED} + * if a new warning is sent to a channel. * * @author Martin Koehler - Initial contribution */ diff --git a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/command/AbstractWriteCommand.java b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/command/AbstractWriteCommand.java index a66644441e930..e08e09d8a3b6c 100644 --- a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/command/AbstractWriteCommand.java +++ b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/command/AbstractWriteCommand.java @@ -43,8 +43,6 @@ public abstract class AbstractWriteCommand extends AbstractCommand { /** * the constructor - * - * @param config */ public AbstractWriteCommand(EaseeThingHandler handler, Channel channel, Command command, RetryOnFailure retryOnFailure, ProcessFailureResponse processFailureResponse, diff --git a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/connector/WebInterface.java b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/connector/WebInterface.java index 657f97a492904..0a677f36dd73a 100644 --- a/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/connector/WebInterface.java +++ b/bundles/org.openhab.binding.easee/src/main/java/org/openhab/binding/easee/internal/connector/WebInterface.java @@ -253,8 +253,6 @@ private void executeCommand() throws ValidationException { /** * Constructor to set up interface - * - * @param config Bridge configuration */ public WebInterface(ScheduledExecutorService scheduler, EaseeBridgeHandler handler, HttpClient httpClient, StatusHandler bridgeStatusHandler) { diff --git a/bundles/org.openhab.binding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/EcovacsXmppDevice.java b/bundles/org.openhab.binding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/EcovacsXmppDevice.java index 1c4229e000f15..28446f13d48ec 100644 --- a/bundles/org.openhab.binding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/EcovacsXmppDevice.java +++ b/bundles/org.openhab.binding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/EcovacsXmppDevice.java @@ -348,7 +348,6 @@ void dispose() { } if (iqRequest instanceof DeviceCommandIQ iq) { - try { if (!iq.id.isEmpty()) { CommandResponseHolder responseHolder = pendingCommands.remove(iq.id); diff --git a/bundles/org.openhab.binding.electroluxair/src/main/java/org/openhab/binding/electroluxair/internal/api/ElectroluxDeltaAPI.java b/bundles/org.openhab.binding.electroluxair/src/main/java/org/openhab/binding/electroluxair/internal/api/ElectroluxDeltaAPI.java index 88249a8edf746..07c5d7d91061a 100644 --- a/bundles/org.openhab.binding.electroluxair/src/main/java/org/openhab/binding/electroluxair/internal/api/ElectroluxDeltaAPI.java +++ b/bundles/org.openhab.binding.electroluxair/src/main/java/org/openhab/binding/electroluxair/internal/api/ElectroluxDeltaAPI.java @@ -96,7 +96,6 @@ public boolean refresh(Map electroluxAirThings) { } } catch (JsonSyntaxException | ElectroluxAirException e) { logger.warn("Failed to refresh! {}", e.getMessage()); - } return false; } diff --git a/bundles/org.openhab.binding.elerotransmitterstick/src/main/java/org/openhab/binding/elerotransmitterstick/internal/EleroTransmitterStickBindingConstants.java b/bundles/org.openhab.binding.elerotransmitterstick/src/main/java/org/openhab/binding/elerotransmitterstick/internal/EleroTransmitterStickBindingConstants.java index 311f2c47b57e6..c9c1857aba0b5 100644 --- a/bundles/org.openhab.binding.elerotransmitterstick/src/main/java/org/openhab/binding/elerotransmitterstick/internal/EleroTransmitterStickBindingConstants.java +++ b/bundles/org.openhab.binding.elerotransmitterstick/src/main/java/org/openhab/binding/elerotransmitterstick/internal/EleroTransmitterStickBindingConstants.java @@ -15,7 +15,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link EleroTransmitterStickBinding} class defines common constants, which are + * The {@link EleroTransmitterStickBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Volker Bier - Initial contribution diff --git a/bundles/org.openhab.binding.energenie/src/main/java/org/openhab/binding/energenie/internal/handler/EnergeniePWMHandler.java b/bundles/org.openhab.binding.energenie/src/main/java/org/openhab/binding/energenie/internal/handler/EnergeniePWMHandler.java index 100e38b9ef8ca..8ab639bf97947 100644 --- a/bundles/org.openhab.binding.energenie/src/main/java/org/openhab/binding/energenie/internal/handler/EnergeniePWMHandler.java +++ b/bundles/org.openhab.binding.energenie/src/main/java/org/openhab/binding/energenie/internal/handler/EnergeniePWMHandler.java @@ -115,7 +115,6 @@ public synchronized void getState() { "failed to logout: " + e.getMessage()); } } - } catch (IOException e) { logger.debug("energenie: failed to login to {} with ip {}", thing.getUID(), host, e); updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage()); diff --git a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/PriceListParser.java b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/PriceListParser.java index 5f4bedc1a3f31..07496a742dae1 100644 --- a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/PriceListParser.java +++ b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/PriceListParser.java @@ -28,7 +28,8 @@ import org.openhab.binding.energidataservice.internal.api.dto.DatahubPricelistRecord; /** - * Parses results from {@link DatahubPricelistRecords} into map of hourly tariffs. + * Parses results from {@link org.openhab.binding.energidataservice.internal.api.dto.DatahubPricelistRecords} + * into map of hourly tariffs. * * @author Jacob Laursen - Initial contribution */ diff --git a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/retry/RetryPolicyFactory.java b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/retry/RetryPolicyFactory.java index 00f0ab89cc4e8..f5174449d626d 100644 --- a/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/retry/RetryPolicyFactory.java +++ b/bundles/org.openhab.binding.energidataservice/src/main/java/org/openhab/binding/energidataservice/internal/retry/RetryPolicyFactory.java @@ -76,7 +76,8 @@ public static RetryStrategy atFixedTime(LocalTime localTime, ZoneId zoneId) { /** * Determine {@link RetryStrategy} when expected spot price data is missing. * - * @param utcTime the time of daily data request in UTC time-zone + * @param localTime local time + * @param zoneId time-zone * @return retry strategy */ public static RetryStrategy whenExpectedSpotPriceDataMissing(LocalTime localTime, ZoneId zoneId) { diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanBindingConstants.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanBindingConstants.java index 346f202525aa1..6e23df84ee6b6 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanBindingConstants.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanBindingConstants.java @@ -35,7 +35,7 @@ import org.openhab.core.thing.type.ChannelTypeUID; /** - * The {@link EnOceanBinding} class defines common constants, which are + * The {@link EnOceanBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Daniel Weber - Initial contribution @@ -221,7 +221,7 @@ public class EnOceanBindingConstants { public static final String CHANNEL_EXHAUSTAIRFANAIRFLOWRATE = "exhaustAirFanAirFlowRate"; public static final String CHANNEL_SUPPLYFANSPEED = "supplyFanSpeed"; public static final String CHANNEL_EXHAUSTFANSPEED = "exhaustFanSpeed"; - public final static String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState"; + public static final String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState"; public static final Map CHANNELID2CHANNELDESCRIPTION = Map.ofEntries( Map.entry(CHANNEL_GENERAL_SWITCHING, diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanChannelDescription.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanChannelDescription.java index ca06c0cd07a53..48da71ae4b265 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanChannelDescription.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/EnOceanChannelDescription.java @@ -34,7 +34,7 @@ public class EnOceanChannelDescription { * Ctor for an EnOceanChannelDescription * * @param channelTypeUID ChannelTypeUID of channel - * @param acceptedItemType AcceptedItemType of channel like Switch, Dimmer or null if we accept everything + * @param itemType ItemType of channel like Switch, Dimmer or null if we accept everything */ public EnOceanChannelDescription(ChannelTypeUID channelTypeUID, String itemType) { this(channelTypeUID, itemType, "", true, true); @@ -44,7 +44,7 @@ public EnOceanChannelDescription(ChannelTypeUID channelTypeUID, String itemType) * Ctor for an EnOceanChannelDescription with detailed information * * @param channelTypeUID ChannelTypeUID of channel - * @param acceptedItemType ItemType of channel like Switch, Dimmer + * @param itemType ItemType of channel like Switch, Dimmer * @param label of created channel * @param isStateChannel otherwise created channel is a trigger channel * @param autoCreate create channel during thing initialization, otherwise channel is created diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09.java index 387c95c7b723d..9141f1376d709 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09.java @@ -146,7 +146,6 @@ private int getUnscaledBatteryVoltageValue() { @Override protected State convertToStateImpl(String channelId, String channelTypeId, Function getCurrentStateFunc, Configuration config) { - if (CHANNEL_CO.equals(channelId)) { return EEPHelper.calculateState(getUnscaledCOValue(), getScaledCOMin(), getScaledCOMax(), getUnscaledCOMin(), getUnscaledCOMax(), Units.PARTS_PER_MILLION); diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_05.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_05.java index 64faa49804bb4..d8681a5f0b570 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_05.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_05.java @@ -76,7 +76,6 @@ protected String getVOCID() { @Override protected State convertToStateImpl(String channelId, String channelTypeId, Function getCurrentStateFunc, Configuration config) { - if (CHANNEL_VOC.equals(channelId)) { double scaledVOC = getUnscaledVOCValue() * getScalingFactor(); return new QuantityType<>(scaledVOC, Units.PARTS_PER_BILLION); diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0C.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0C.java index 24962869ce305..d72ec055b3e58 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0C.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0C.java @@ -51,7 +51,6 @@ protected String[] getVOCIdentifications() { @Override protected State convertToStateImpl(String channelId, String channelTypeId, Function getCurrentStateFunc, Configuration config) { - if (CHANNEL_VOC.equals(channelId)) { double scaledVOC = getUnscaledVOCValue() * getScalingFactor(); if (getBit(getDB0(), 2)) { diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0D.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0D.java index 1a21e3b775043..5a6e44f17492f 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0D.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_09/A5_09_0D.java @@ -42,7 +42,6 @@ protected double getUnscaledTemperatureMax() { @Override protected State convertToStateImpl(String channelId, String channelTypeId, Function getCurrentStateFunc, Configuration config) { - if (CHANNEL_TVOC.equals(channelId)) { return EEPHelper.calculateState(getDB2Value(), 0, 100, 0, 200, Units.PERCENT); } diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_10/A5_10.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_10/A5_10.java index f97c9e7041c27..d60f7e8472999 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_10/A5_10.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_10/A5_10.java @@ -111,9 +111,7 @@ protected State getSupplyVoltage() { @Override protected State convertToStateImpl(String channelId, String channelTypeId, Function getCurrentStateFunc, Configuration config) { - switch (channelId) { - case CHANNEL_BATTERY_VOLTAGE: return getSupplyVoltage(); diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_38/A5_38_08_Dimming.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_38/A5_38_08_Dimming.java index 2d5771c21af58..5199a701b14ef 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_38/A5_38_08_Dimming.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/A5_38/A5_38_08_Dimming.java @@ -35,8 +35,10 @@ /** * This class tries to combine the classic EEP A5-38-08 CMD 0x02 dimming with the Eltako interpretation of this EEP. * It is doing it by channel config parameter "eltakoDimmer". The differences are: + *
    *
  • Dimming value 0-100%: standard 0-255, Eltako 0-100
  • *
  • Store value: standard DB0.1, Eltako DB0.2
  • + *
* * @author Daniel Weber - Initial contribution */ diff --git a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/EEPHelper.java b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/EEPHelper.java index b87582f9b77cb..7e0f3607006cc 100644 --- a/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/EEPHelper.java +++ b/bundles/org.openhab.binding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/EEPHelper.java @@ -83,7 +83,6 @@ public static boolean validateUnscaledValue(int unscaledValue, double unscaledMi public static State calculateState(int unscaledValue, double scaledMin, double scaledMax, double unscaledMin, double unscaledMax, Unit unit) { - if (!validateUnscaledValue(unscaledValue, unscaledMin, unscaledMax)) { return UnDefType.UNDEF; } 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 f75a774a4c746..a493587332ae5 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,8 +66,10 @@ import org.slf4j.LoggerFactory; /** - * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by {@link EnOceanActuatorHandler} and - * transferring received ESP3Packages to {@link EnOceanSensorHandler}. + * 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}. * * @author Daniel Weber - Initial contribution */ diff --git a/bundles/org.openhab.binding.evohome/src/main/java/org/openhab/binding/evohome/internal/handler/BaseEvohomeHandler.java b/bundles/org.openhab.binding.evohome/src/main/java/org/openhab/binding/evohome/internal/handler/BaseEvohomeHandler.java index 11048291cde0e..bbb30e519e667 100644 --- a/bundles/org.openhab.binding.evohome/src/main/java/org/openhab/binding/evohome/internal/handler/BaseEvohomeHandler.java +++ b/bundles/org.openhab.binding.evohome/src/main/java/org/openhab/binding/evohome/internal/handler/BaseEvohomeHandler.java @@ -88,8 +88,6 @@ protected EvohomeThingConfiguration getEvohomeThingConfig() { /** * Retrieves the evohome configuration from the bridge - * - * @return The current evohome configuration */ protected void requestUpdate() { Bridge bridge = getBridge(); diff --git a/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/Measurand.java b/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/Measurand.java index 65d3f15f7ef8b..1693b73445963 100644 --- a/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/Measurand.java +++ b/bundles/org.openhab.binding.fineoffsetweatherstation/src/main/java/org/openhab/binding/fineoffsetweatherstation/internal/domain/Measurand.java @@ -329,7 +329,6 @@ private static class MeasurandParser implements Parser { if (customizations.length == 0) { this.customizations = null; } else { - this.customizations = Collections.unmodifiableMap( Arrays.stream(customizations).collect(Collectors.toMap(ParserCustomization::getType, customization -> customization, (a, b) -> b, HashMap::new))); diff --git a/bundles/org.openhab.binding.flicbutton/src/3rdparty/java/io/flic/fliclib/javaclient/ButtonScanner.java b/bundles/org.openhab.binding.flicbutton/src/3rdparty/java/io/flic/fliclib/javaclient/ButtonScanner.java index 41ca1487e8cf9..a550ea17e8ee0 100644 --- a/bundles/org.openhab.binding.flicbutton/src/3rdparty/java/io/flic/fliclib/javaclient/ButtonScanner.java +++ b/bundles/org.openhab.binding.flicbutton/src/3rdparty/java/io/flic/fliclib/javaclient/ButtonScanner.java @@ -6,7 +6,8 @@ /** * Button scanner class. * - * Inherit this class and override the {@link #onAdvertisementPacket(Bdaddr, String, int, boolean, boolean)} method. + * Inherit this class and override the + * {@link #onAdvertisementPacket(Bdaddr, String, int, boolean, boolean, boolean, boolean)} method. * Then add this button scanner to a {@link FlicClient} using {@link FlicClient#addScanner(ButtonScanner)} to start it. */ public abstract class ButtonScanner { 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 c8f724ba7636a..589e5db03683c 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 @@ -125,7 +125,7 @@ public Client() { * @return data corresponding to the query * @throws FMIIOException on all I/O errors * @throws FMIUnexpectedResponseException on all unexpected content errors - * @throw FMIExceptionReportException on explicit error responses from the server + * @throws FMIExceptionReportException on explicit error responses from the server */ public FMIResponse query(Request request, int timeoutMillis) throws FMIExceptionReportException, FMIUnexpectedResponseException, FMIIOException { @@ -152,7 +152,7 @@ public FMIResponse query(Request request, int timeoutMillis) * @return locations representing stations * @throws FMIIOException on all I/O errors * @throws FMIUnexpectedResponseException on all unexpected content errors - * @throw FMIExceptionReportException on explicit error responses from the server + * @throws FMIExceptionReportException on explicit error responses from the server */ public Set queryWeatherStations(int timeoutMillis) throws FMIIOException, FMIUnexpectedResponseException, FMIExceptionReportException { diff --git a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/FMIWeatherDiscoveryService.java b/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/FMIWeatherDiscoveryService.java index 5bd6d2ae68d96..d1280986632ce 100644 --- a/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/FMIWeatherDiscoveryService.java +++ b/bundles/org.openhab.binding.fmiweather/src/main/java/org/openhab/binding/fmiweather/internal/discovery/FMIWeatherDiscoveryService.java @@ -49,7 +49,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link FMIDiscoveryService} creates things based on the configured location. + * The {@link FMIWeatherDiscoveryService} creates things based on the configured location. * * @author Sami Salonen - Initial contribution */ diff --git a/bundles/org.openhab.binding.folding/src/main/java/org/openhab/binding/folding/internal/FoldingBindingConstants.java b/bundles/org.openhab.binding.folding/src/main/java/org/openhab/binding/folding/internal/FoldingBindingConstants.java index 659c1b8d37c21..b82a03d056631 100644 --- a/bundles/org.openhab.binding.folding/src/main/java/org/openhab/binding/folding/internal/FoldingBindingConstants.java +++ b/bundles/org.openhab.binding.folding/src/main/java/org/openhab/binding/folding/internal/FoldingBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link FoldingBinding} class defines common constants, which are + * The {@link FoldingBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Marius Bjoernstad - Initial contribution diff --git a/bundles/org.openhab.binding.foobot/src/main/java/org/openhab/binding/foobot/internal/FoobotBindingConstants.java b/bundles/org.openhab.binding.foobot/src/main/java/org/openhab/binding/foobot/internal/FoobotBindingConstants.java index 8bcb44e8f27c3..3f52ac9922592 100644 --- a/bundles/org.openhab.binding.foobot/src/main/java/org/openhab/binding/foobot/internal/FoobotBindingConstants.java +++ b/bundles/org.openhab.binding.foobot/src/main/java/org/openhab/binding/foobot/internal/FoobotBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link FoobotBinding} class defines common constants, which are + * The {@link FoobotBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Divya Chauhan - Initial contribution diff --git a/bundles/org.openhab.binding.freebox/src/main/java/org/openhab/binding/freebox/internal/FreeboxBindingConstants.java b/bundles/org.openhab.binding.freebox/src/main/java/org/openhab/binding/freebox/internal/FreeboxBindingConstants.java index 7f10dd73da19e..97b28e728f488 100644 --- a/bundles/org.openhab.binding.freebox/src/main/java/org/openhab/binding/freebox/internal/FreeboxBindingConstants.java +++ b/bundles/org.openhab.binding.freebox/src/main/java/org/openhab/binding/freebox/internal/FreeboxBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link FreeboxBinding} class defines common constants, which are + * The {@link FreeboxBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Gaël L'hopital - Initial contribution diff --git a/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/FreeboxOsBindingConstants.java b/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/FreeboxOsBindingConstants.java index 88c71f283dea5..139da4ecf65f6 100644 --- a/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/FreeboxOsBindingConstants.java +++ b/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/FreeboxOsBindingConstants.java @@ -25,7 +25,7 @@ import org.openhab.core.types.Command; /** - * The {@link FreeboxBinding} class defines common constants, which are used across the binding. + * The {@link FreeboxOsBindingConstants} class defines common constants, which are used across the binding. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/api/FreeboxOsIconProvider.java b/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/api/FreeboxOsIconProvider.java index 2895adde5b44d..8c5067226dfac 100644 --- a/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/api/FreeboxOsIconProvider.java +++ b/bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/api/FreeboxOsIconProvider.java @@ -42,7 +42,7 @@ import org.slf4j.LoggerFactory; /** - * The {@FreeboxOsIconProvider} delivers icons provided by FreeboxOS + * The {@link FreeboxOsIconProvider} delivers icons provided by FreeboxOS * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDTO.java index 5c78785462081..63fd13ac2985b 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link MeterRealtimeBody} is responsible for storing + * The {@link MeterRealtimeBodyDTO} is responsible for storing * the "body" node of the JSON response * * @author Jimmy Tanagra - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDataDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDataDTO.java index a7db9ea2c4a18..ca133731cc236 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDataDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeBodyDataDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link MeterRealtimeBodyData} is responsible for storing + * The {@link MeterRealtimeBodyDataDTO} is responsible for storing * the "data" node of the JSON response * * The main SerializedName values use Smart Meter 63A names diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeDetailsDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeDetailsDTO.java index 2cd583be193d1..fb28694329bae 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeDetailsDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeDetailsDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link MeterRealtimeDetails} is responsible for storing + * The {@link MeterRealtimeDetailsDTO} is responsible for storing * the "body" node of the JSON response * * @author Jimmy Tanagra - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeResponseDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeResponseDTO.java index 86bbdc7a3a055..e948642ca2dbd 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeResponseDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/MeterRealtimeResponseDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link MeterRealtimeResponse} is responsible for storing + * The {@link MeterRealtimeResponseDTO} is responsible for storing * the response from the powerflowrealtime api * * @author Jimmy Tanagra - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDTO.java index 4722cdd282df4..3e3b4c917a5ed 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link OhmpilotRealtimeBody} is responsible for storing + * The {@link OhmpilotRealtimeBodyDTO} is responsible for storing * the "body" node of the JSON response * * @author Hannes Spenger - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDataDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDataDTO.java index 59dc626fe4fea..a14a6d8445d20 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDataDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeBodyDataDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link OhmpilotRealtimeBodyData} is responsible for storing + * The {@link OhmpilotRealtimeBodyDataDTO} is responsible for storing * the "data" node of the JSON response * * @author Hannes Spenger - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeDetailsDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeDetailsDTO.java index a8cfca14164b5..f3a7aac0d3281 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeDetailsDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeDetailsDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link OhmpilotRealtimeDetails} is responsible for storing + * The {@link OhmpilotRealtimeDetailsDTO} is responsible for storing * the "body" node of the JSON response * * @author Hannes Spenger - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeResponseDTO.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeResponseDTO.java index ca16bc6d24d5f..8d1cae339d0fa 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeResponseDTO.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/api/OhmpilotRealtimeResponseDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link OhmpilotRealtimeResponse} is responsible for storing + * The {@link OhmpilotRealtimeResponseDTO} is responsible for storing * the response from the GetOhmPilotRealtimeData api * * @author Hannes Spenger - Initial contribution diff --git a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusBaseThingHandler.java b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusBaseThingHandler.java index 7211379548416..7a9906d7f0059 100644 --- a/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusBaseThingHandler.java +++ b/bundles/org.openhab.binding.fronius/src/main/java/org/openhab/binding/fronius/internal/handler/FroniusBaseThingHandler.java @@ -192,7 +192,6 @@ protected abstract void handleRefresh(FroniusBridgeConfiguration bridgeConfigura Thread.sleep(500 * attempts); attempts++; } - } catch (JsonSyntaxException | NumberFormatException e) { logger.debug("Received Invalid JSON Data", e); throw new FroniusCommunicationException("Invalid JSON data received", e); diff --git a/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioConnection.java b/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioConnection.java index d74f2fe1b5877..1a886fd488f0b 100644 --- a/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioConnection.java +++ b/bundles/org.openhab.binding.fsinternetradio/src/main/java/org/openhab/binding/fsinternetradio/internal/radio/FrontierSiliconRadioConnection.java @@ -124,8 +124,7 @@ public boolean doLogin() throws IOException { * * Typically used for polling state info. * - * @param REST - * API requestString, e.g. "GET/netRemote.sys.power" + * @param requestString REST API request, e.g. "GET/netRemote.sys.power" * @return request result * @throws IOException if the request failed. */ @@ -138,10 +137,8 @@ public FrontierSiliconRadioApiResult doRequest(String requestString) throws IOEx * * Typically used for changing parameters. * - * @param REST - * API requestString, e.g. "SET/netRemote.sys.power" - * @param params - * , e.g. "value=1" + * @param requestString REST API request, e.g. "SET/netRemote.sys.power" + * @param params parameters, e.g. "value=1" * @return request result * @throws IOException if the request failed. */ diff --git a/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/FtpUploadBindingConstants.java b/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/FtpUploadBindingConstants.java index 1ec0bd973e5d8..f3e2dcc417821 100644 --- a/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/FtpUploadBindingConstants.java +++ b/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/FtpUploadBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link FtpUploadBinding} class defines common constants, which are + * The {@link FtpUploadBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Pauli Anttila - Initial contribution diff --git a/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/config/FtpUploadConfig.java b/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/config/FtpUploadConfig.java index 6ad7883f81f8e..7ea6c08212737 100644 --- a/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/config/FtpUploadConfig.java +++ b/bundles/org.openhab.binding.ftpupload/src/main/java/org/openhab/binding/ftpupload/internal/config/FtpUploadConfig.java @@ -13,7 +13,7 @@ package org.openhab.binding.ftpupload.internal.config; /** - * Configuration class for {@link FtpUploadBinding} device. + * Configuration class for FtpUpload device. * * @author Pauli Anttila - Initial contribution */ diff --git a/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java b/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java index b942887a5c5f3..5b88c3cfabd76 100644 --- a/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java +++ b/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/command/AbstractCommand.java @@ -217,7 +217,6 @@ private boolean sendCommand() { if (isErrorReply(deviceReply)) { return false; } - } catch (InterruptedException e) { createGenericError("Poll of response queue was interrupted"); return false; @@ -326,7 +325,6 @@ private String lookupErrorMessage(String errorCode, String[] errorMessageArray) int eCode; try { eCode = Integer.parseInt(errorCode); - } catch (NumberFormatException e) { eCode = 0; logger.debug("Badly formatted error code '{}' received from device: {}", errorCode, e.getMessage()); diff --git a/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/discovery/MulticastListener.java b/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/discovery/MulticastListener.java index 940556d9b826a..b37c02dcd5d55 100644 --- a/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/discovery/MulticastListener.java +++ b/bundles/org.openhab.binding.globalcache/src/main/java/org/openhab/binding/globalcache/internal/discovery/MulticastListener.java @@ -105,7 +105,6 @@ public boolean waitForBeacon() throws IOException { beaconFound = true; logger.trace("Multicast listener got datagram of length {} from multicast port: {}", msgPacket.getLength(), msgPacket.toString()); - } catch (SocketTimeoutException e) { beaconFound = false; } diff --git a/bundles/org.openhab.binding.goecharger/src/main/java/org/openhab/binding/goecharger/internal/api/GoEStatusResponseDTO.java b/bundles/org.openhab.binding.goecharger/src/main/java/org/openhab/binding/goecharger/internal/api/GoEStatusResponseDTO.java index 227d6c6a0a3b2..4bff8129945ff 100644 --- a/bundles/org.openhab.binding.goecharger/src/main/java/org/openhab/binding/goecharger/internal/api/GoEStatusResponseDTO.java +++ b/bundles/org.openhab.binding.goecharger/src/main/java/org/openhab/binding/goecharger/internal/api/GoEStatusResponseDTO.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link GoEStatusResponse} class represents a json response from the + * The {@link GoEStatusResponseDTO} class represents a json response from the * charger. * * @author Samuel Brucksch - Initial contribution diff --git a/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOBindingConstants.java b/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOBindingConstants.java index accdcf4bc0d42..f23e90dd00193 100644 --- a/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOBindingConstants.java +++ b/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOBindingConstants.java @@ -17,7 +17,7 @@ import org.openhab.core.thing.type.ChannelTypeUID; /** - * The {@link gpioBindingConstants} class defines common constants, which are + * The {@link GPIOBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Nils Bauer - Initial contribution diff --git a/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOHandlerFactory.java b/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOHandlerFactory.java index 964b77e09945c..cfed4890b2d08 100644 --- a/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOHandlerFactory.java +++ b/bundles/org.openhab.binding.gpio/src/main/java/org/openhab/binding/gpio/internal/GPIOHandlerFactory.java @@ -27,7 +27,7 @@ import org.osgi.service.component.annotations.Component; /** - * The {@link gpioHandlerFactory} is responsible for creating things and thing + * The {@link GPIOHandlerFactory} is responsible for creating things and thing * handlers. * * @author Nils Bauer - Initial contribution 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 acd0a1e701d7b..0fdbc6c745482 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,7 @@ 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 621f31af4f066..22bdec05775c8 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 @@ -270,7 +270,7 @@ public void setDeviceLight(DatagramSocket clientSocket, int value) throws GreeEx } /** - * @param value set temperature in degrees Celsius or Fahrenheit + * @param temp set temperature in degrees Celsius or Fahrenheit */ public void setDeviceTempSet(DatagramSocket clientSocket, QuantityType temp) throws GreeException { // If commanding Fahrenheit set halfStep to 1 or 0 to tell the A/C which F integer diff --git a/bundles/org.openhab.binding.groheondus/src/main/java/org/openhab/binding/groheondus/internal/handler/GroheOndusSenseGuardHandler.java b/bundles/org.openhab.binding.groheondus/src/main/java/org/openhab/binding/groheondus/internal/handler/GroheOndusSenseGuardHandler.java index 5d4b342ae6b3a..69587785f301f 100644 --- a/bundles/org.openhab.binding.groheondus/src/main/java/org/openhab/binding/groheondus/internal/handler/GroheOndusSenseGuardHandler.java +++ b/bundles/org.openhab.binding.groheondus/src/main/java/org/openhab/binding/groheondus/internal/handler/GroheOndusSenseGuardHandler.java @@ -100,7 +100,6 @@ protected void updateChannel(ChannelUID channelUID, Appliance appliance, Data da newState = new QuantityType<>(lastMeasurement.getTemperatureGuard(), SIUnits.CELSIUS); break; case CHANNEL_VALVE_OPEN: - OnOffType valveOpenType = getValveOpenType(appliance); if (valveOpenType != null) { newState = valveOpenType; diff --git a/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/bridge/GroupePSABridgeHandler.java b/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/bridge/GroupePSABridgeHandler.java index 9f0decd6a484d..9335275919266 100644 --- a/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/bridge/GroupePSABridgeHandler.java +++ b/bundles/org.openhab.binding.groupepsa/src/main/java/org/openhab/binding/groupepsa/internal/bridge/GroupePSABridgeHandler.java @@ -217,7 +217,7 @@ public GroupePSAConnectApi getAPI() throws GroupePSACommunicationException { } /** - * @param id The id of the mower to query + * @param vin The VIN to query * @return A detailed status of the mower with the specified id * @throws GroupePSACommunicationException In case the query cannot be executed * successfully diff --git a/bundles/org.openhab.binding.harmonyhub/src/main/java/org/openhab/binding/harmonyhub/internal/HarmonyHubBindingConstants.java b/bundles/org.openhab.binding.harmonyhub/src/main/java/org/openhab/binding/harmonyhub/internal/HarmonyHubBindingConstants.java index 2c4501489fed5..f4bf213e49f63 100644 --- a/bundles/org.openhab.binding.harmonyhub/src/main/java/org/openhab/binding/harmonyhub/internal/HarmonyHubBindingConstants.java +++ b/bundles/org.openhab.binding.harmonyhub/src/main/java/org/openhab/binding/harmonyhub/internal/HarmonyHubBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link HarmonyHubBinding} class defines common constants, which are + * The {@link HarmonyHubBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Dan Cunningham - Initial contribution diff --git a/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardDynamicStateDescriptionProvider.java b/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardDynamicStateDescriptionProvider.java index b3faade3a6987..f45b12c004613 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardDynamicStateDescriptionProvider.java +++ b/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardDynamicStateDescriptionProvider.java @@ -34,8 +34,8 @@ import org.osgi.service.component.annotations.Reference; /** - * Dynamic provider of state options for {@link HueBridgeHandler} while leaving other state description fields as - * original. + * Dynamic provider of state options for {@link org.openhab.binding.hue.internal.handler.HueBridgeHandler} + * while leaving other state description fields as original. * * @author Matt Myers - Initial contribution */ diff --git a/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardThingHandler.java b/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardThingHandler.java index 48db232cad371..fab42aa6c89b5 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardThingHandler.java +++ b/bundles/org.openhab.binding.haywardomnilogic/src/main/java/org/openhab/binding/haywardomnilogic/internal/HaywardThingHandler.java @@ -35,7 +35,7 @@ import org.openhab.core.types.State; /** - * The {@link HaywarThingHandler} is a subclass of the BaseThingHandler and a Super + * The {@link HaywardThingHandler} is a subclass of the BaseThingHandler and a Super * Class to each Hayward Thing Handler * * @author Matt Myers - Initial contribution diff --git a/bundles/org.openhab.binding.hdanywhere/src/main/java/org/openhab/binding/hdanywhere/internal/HDanywhereBindingConstants.java b/bundles/org.openhab.binding.hdanywhere/src/main/java/org/openhab/binding/hdanywhere/internal/HDanywhereBindingConstants.java index 565b5f798faf8..29aef94756ec6 100644 --- a/bundles/org.openhab.binding.hdanywhere/src/main/java/org/openhab/binding/hdanywhere/internal/HDanywhereBindingConstants.java +++ b/bundles/org.openhab.binding.hdanywhere/src/main/java/org/openhab/binding/hdanywhere/internal/HDanywhereBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link HDanywhereBinding} class defines common constants, which are used + * The {@link HDanywhereBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/HDPowerViewBindingConstants.java b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/HDPowerViewBindingConstants.java index 7436cd05005a1..6649024bae82c 100644 --- a/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/HDPowerViewBindingConstants.java +++ b/bundles/org.openhab.binding.hdpowerview/src/main/java/org/openhab/binding/hdpowerview/internal/HDPowerViewBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link HDPowerViewBinding} class defines common constants, which are + * The {@link HDPowerViewBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Andy Lintner - Initial contribution diff --git a/bundles/org.openhab.binding.helios/src/main/java/org/openhab/binding/helios/internal/HeliosBindingConstants.java b/bundles/org.openhab.binding.helios/src/main/java/org/openhab/binding/helios/internal/HeliosBindingConstants.java index b2e67f440584d..75572883031a8 100644 --- a/bundles/org.openhab.binding.helios/src/main/java/org/openhab/binding/helios/internal/HeliosBindingConstants.java +++ b/bundles/org.openhab.binding.helios/src/main/java/org/openhab/binding/helios/internal/HeliosBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link HeliosBinding} class defines common constants, which are used + * The {@link HeliosBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/HeosBindingConstants.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/HeosBindingConstants.java index e9d90ef289009..a356a06141a94 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/HeosBindingConstants.java +++ b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/HeosBindingConstants.java @@ -23,7 +23,7 @@ import org.openhab.core.thing.type.ChannelTypeUID; /** - * The {@link HeosBinding} class defines common constants, which are + * The {@link HeosBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Johannes Einig - 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 92f5e38272f3c..68a257816be17 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 @@ -457,8 +457,8 @@ public void playMediaFromQueue(String pid, String qid) throws IOException, ReadE /** * Asks for the actual state of the player. The result has - * to be handled by the event controller. The system returns {@link HeosConstants.PLAY}, - * {@link HeosConstants.PAUSE} or {@link HeosConstants.STOP}. + * to be handled by the event controller. The system returns {@link HeosConstants#PLAY}, + * {@link HeosConstants#PAUSE} or {@link HeosConstants#STOP}. * * @param id The player ID the state shall get for * @return @@ -469,8 +469,8 @@ public HeosResponseObject getPlayState(String id) throws IOException, Read /** * Ask for the actual mute state of the player. The result has - * to be handled by the event controller. The HEOS system returns {@link HeosConstants.ON} - * or {@link HeosConstants.OFF}. + * to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON} + * or {@link HeosConstants#OFF}. * * @param id The player id the mute state shall get for * @return @@ -493,8 +493,8 @@ public HeosResponseObject getPlayerVolume(String id) throws IOException, R /** * 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} + * 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} * * @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/HeosStringPropertyChangeListener.java b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java index 7804b6e9a1c9a..1a894738c9071 100644 --- a/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java +++ b/bundles/org.openhab.binding.heos/src/main/java/org/openhab/binding/heos/internal/resources/HeosStringPropertyChangeListener.java @@ -20,7 +20,7 @@ import org.slf4j.LoggerFactory; /** - * The {@Link HeosStringPropertyChangeListener} provides the possibility + * The {@link HeosStringPropertyChangeListener} provides the possibility * to add a listener to a String and get informed about the new value. * * @author Johannes Einig - Initial contribution diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/communicator/HomematicGateway.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/communicator/HomematicGateway.java index b2253426a4ad1..6d8b2a237207a 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/communicator/HomematicGateway.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/communicator/HomematicGateway.java @@ -87,9 +87,10 @@ public interface HomematicGateway { * @param dpConfig The configuration of the datapoint * @param newValue The new value for the datapoint * @param rxMode The rxMode with which the value should be sent to the device - * ({@link HomematicBindingConstants#RX_BURST_MODE "BURST"} for burst mode, - * {@link HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"} for wakeup mode, or null for the default - * mode) + * ({@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_BURST_MODE "BURST"} + * for burst mode, + * {@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"} + * for wakeup mode, or null for the default mode) */ void sendDatapoint(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue, String rxMode) throws IOException, HomematicClientException; diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/converter/type/QuantityTypeConverter.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/converter/type/QuantityTypeConverter.java index 37fd497d8778d..86bba5446561a 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/converter/type/QuantityTypeConverter.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/converter/type/QuantityTypeConverter.java @@ -25,7 +25,7 @@ import org.openhab.core.types.Type; /** - * Converts between a Homematic datapoint value and a {@link DecimalType}. + * Converts between a Homematic datapoint value and a {@link org.openhab.core.library.types.DecimalType}. * * @author Michael Reitler - Initial contribution */ diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelGroupTypeProvider.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelGroupTypeProvider.java index 381389be0dcae..404cc691c2607 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelGroupTypeProvider.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelGroupTypeProvider.java @@ -32,7 +32,7 @@ public interface HomematicChannelGroupTypeProvider extends ChannelGroupTypeProvi * Use this method to lookup a ChannelGroupType which was generated by the * homematic binding. Other than {@link #getChannelGroupType(ChannelGroupTypeUID, Locale)} * of this provider, it will return also those {@link ChannelGroupType}s - * which are excluded by {@link HomematicThingTypeExcluder} + * which are excluded by {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder} * * @param channelGroupTypeUID * e.g. homematic:HM-WDS40-TH-I-2_0 diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelTypeProvider.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelTypeProvider.java index ece631a2ac0cc..88d201f62e075 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelTypeProvider.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/internal/type/HomematicChannelTypeProvider.java @@ -32,7 +32,8 @@ public interface HomematicChannelTypeProvider extends ChannelTypeProvider { * Use this method to lookup a ChannelType which was generated by the * homematic binding. Other than {@link #getChannelType(ChannelTypeUID, Locale)} * of this provider, it will return also those {@link ChannelType}s - * which are excluded by {@link HomematicThingTypeExcluder} + * which are excluded by + * {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder} * * @param channelTypeUID * e.g. homematic:HM-WDS40-TH-I-2_0_RSSI_DEVICE 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 10a8c82e07f8e..3d9086eb0a401 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 @@ -46,8 +46,10 @@ public interface HomematicConfigDescriptionProvider extends ConfigDescriptionPro /** * Use this method to lookup a ConfigDescription which was generated by the * homematic binding. Other than {@link #getConfigDescription(URI, Locale)} - * of this provider, it will return also those {@link ConfigDescription}s - * which are excluded by {@link HomematicThingTypeExcluder} + * of this provider, it will return also those + * {@link org.openhab.core.config.core.ConfigDescription}s + * which are excluded by + * {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder} * * @param URI config-description-uri * e.g. thing-type:homematic:HM-WDS40-TH-I-2 diff --git a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/type/HomematicThingTypeExcluder.java b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/type/HomematicThingTypeExcluder.java index e63d1b287da86..62fbae4251e1a 100644 --- a/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/type/HomematicThingTypeExcluder.java +++ b/bundles/org.openhab.binding.homematic/src/main/java/org/openhab/binding/homematic/type/HomematicThingTypeExcluder.java @@ -32,6 +32,7 @@ public interface HomematicThingTypeExcluder { /** * Returns list of ThingTypes to be excluded. Clients which implement this * are henceforth responsible to ... + *
    *
  • provide any excluded ThingType on their own - e.g. in a custom * {@link org.openhab.core.thing.binding.ThingTypeProvider} or by * defining those {@link org.openhab.core.thing.type.ThingType}s in XML.
  • @@ -43,6 +44,7 @@ public interface HomematicThingTypeExcluder { * {@link org.openhab.core.thing.Channel}) which can be handled by * the binding (see * {@link org.openhab.binding.homematic.internal.handler.HomematicThingHandler}) + *
* * @return {@link ThingTypeUID}s of ThingTypes that are supposed to be * excluded from the binding's thing-type generation diff --git a/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/CascadedValueTransformationImpl.java b/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/CascadedValueTransformationImpl.java index 5c1d4be7d809f..3a690203b89c3 100644 --- a/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/CascadedValueTransformationImpl.java +++ b/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/CascadedValueTransformationImpl.java @@ -25,8 +25,8 @@ import org.slf4j.LoggerFactory; /** - * The {@link CascadedValueTransformationImpl} implements {@link ValueTransformation for a cascaded set of - * transformations} + * The {@link CascadedValueTransformationImpl} implements {@link ValueTransformation} for a cascaded set of + * transformations * * @author Jan N. Klug - Initial contribution */ diff --git a/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/SingleValueTransformation.java b/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/SingleValueTransformation.java index 779da2d103398..9c09737651c81 100644 --- a/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/SingleValueTransformation.java +++ b/bundles/org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/transform/SingleValueTransformation.java @@ -24,7 +24,7 @@ import org.slf4j.LoggerFactory; /** - * A transformation for a value used in {@HttpChannel}. + * A transformation for a value used in {@link HttpChannel}. * * @author David Graeff - Initial contribution * @author Jan N. Klug - adapted from MQTT binding to HTTP binding diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/connection/Clip2Bridge.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/connection/Clip2Bridge.java index 6c2f8d84317fc..48dffef57ac09 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/connection/Clip2Bridge.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/connection/Clip2Bridge.java @@ -98,9 +98,11 @@ * * It uses the following connection mechanisms: * + *
    *
  • The primary communication uses HTTP 2 streams over a shared permanent HTTP 2 session.
  • *
  • The 'registerApplicationKey()' method uses HTTP/1.1 over the OH common Jetty client.
  • *
  • The 'isClip2Supported()' static method uses HTTP/1.1 over the OH common Jetty client via 'HttpUtil'.
  • + *
* * @author Andrew Fiddian-Green - Initial Contribution */ diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueBridgeMDNSDiscoveryParticipant.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueBridgeMDNSDiscoveryParticipant.java index 46c8915a42eb0..ad412483c8214 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueBridgeMDNSDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueBridgeMDNSDiscoveryParticipant.java @@ -43,7 +43,7 @@ /** * The {@link HueBridgeMDNSDiscoveryParticipant} is responsible for discovering new and removed Hue Bridges. It uses the - * central MDNSDiscoveryService. + * central {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}. * * @author Kai Kreuzer - Initial contribution * @author Thomas Höfer - Added representation diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueDeviceDiscoveryService.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueDeviceDiscoveryService.java index 1189813b52e44..d05a10943372d 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueDeviceDiscoveryService.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/discovery/HueDeviceDiscoveryService.java @@ -51,7 +51,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link HueBridgeServiceTracker} tracks for Hue lights, sensors and groups which are connected + * The {@link HueDeviceDiscoveryService} tracks for Hue lights, sensors and groups which are connected * to a paired Hue Bridge. The default search time for Hue is 60 seconds. * * @author Kai Kreuzer - Initial contribution diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/GroupStatusListener.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/GroupStatusListener.java index bb85453f258e9..27705e8710fa0 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/GroupStatusListener.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/GroupStatusListener.java @@ -62,7 +62,7 @@ public interface GroupStatusListener { /** * This method is called whenever the list of available scenes is updated. * - * @param updatedScenes available scenes + * @param scenes available scenes */ void onScenesUpdated(List scenes); } diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueBridgeHandler.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueBridgeHandler.java index db6c6f29c75cd..30991dd198e08 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueBridgeHandler.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueBridgeHandler.java @@ -799,7 +799,6 @@ private boolean tryResumeBridgeConnection() throws IOException, ApiException { * If there is a user name available, it attempts to re-authenticate. Otherwise new authentication credentials will * be requested from the bridge. * - * @param bridge the Hue Bridge the connection is not authorized * @return returns {@code true} if re-authentication was successful, {@code false} otherwise */ public boolean onNotAuthenticated() { diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueSensorHandler.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueSensorHandler.java index bbd9b7f8d8d6f..8d3210a57ed0c 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueSensorHandler.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/HueSensorHandler.java @@ -320,7 +320,6 @@ public void channelLinked(ChannelUID channelUID) { * Handles the sensor change. Implementation should also update sensor-specific configuration that changed since the * last update. * - * @param bridge the bridge * @param sensor the sensor * @param config the configuration in which to update the config states of the sensor */ diff --git a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/LightStateConverter.java b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/LightStateConverter.java index 36689d82854f6..525d1f4520bca 100644 --- a/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/LightStateConverter.java +++ b/bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/handler/LightStateConverter.java @@ -294,7 +294,7 @@ private static HSBType fromXYtoHSBType(State lightState) { *
  • {@value #ALERT_MODE_NONE}. *
  • {@value #ALERT_MODE_SELECT}. *
  • {@value #ALERT_MODE_LONG_SELECT}. - *
      + *
    * @return light state containing the {@link AlertMode} or null if the provided * {@link StringType} represents unsupported mode. */ diff --git a/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/HyperionBindingConstants.java b/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/HyperionBindingConstants.java index 3c3874cdaaad9..a23d92c048c94 100644 --- a/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/HyperionBindingConstants.java +++ b/bundles/org.openhab.binding.hyperion/src/main/java/org/openhab/binding/hyperion/internal/HyperionBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link HyperionBinding} class defines common constants, which are + * The {@link HyperionBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Daniel Walters - Initial contribution 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 f8dd96fb85359..5176b9cdaedf0 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 @@ -177,8 +177,8 @@ public OneTouch[] getOneTouch(@Nullable String serialNumber, @Nullable String se /** * Retrieves {@link Auxiliary[]} devices * - * @param serialNumber - * @param sessionId + * @param serial + * @param sessionID * @return {@link Auxiliary[]} * @throws IOException * @throws NotAuthorizedException @@ -221,10 +221,11 @@ public Auxiliary[] auxSetCommand(@Nullable String serial, @Nullable String sessi /** * Sends an Auxiliary light command * - * @param serialNumber - * @param sessionId - * @param command + * @param serial + * @param sessionID + * @param auxID * @param lightValue + * @param subtype * @return * @throws IOException * @throws NotAuthorizedException @@ -263,8 +264,8 @@ public Auxiliary[] dimmerCommand(@Nullable String serial, @Nullable String sessi /** * Sets the Spa Temperature Setpoint * - * @param serialNumber - * @param sessionId + * @param serial + * @param sessionID * @param spaSetpoint * @return * @throws IOException @@ -282,8 +283,8 @@ public Home setSpaTemp(@Nullable String serial, @Nullable String sessionID, floa /** * Sets the Pool Temperature Setpoint * - * @param serialNumber - * @param sessionId + * @param serial + * @param sessionID * @param poolSetpoint * @return * @throws IOException diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/config/IhcConfiguration.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/config/IhcConfiguration.java index f960effd8f3c3..313138738e5e7 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/config/IhcConfiguration.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/config/IhcConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.ihc.internal.config; /** - * Configuration class for {@link IhcBinding} binding. + * Configuration class for IhcBinding binding. * * @author Pauli Anttila - Initial contribution */ diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/IhcClient.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/IhcClient.java index a822dde790bf6..18ba2b723bbdd 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/IhcClient.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/IhcClient.java @@ -377,7 +377,6 @@ private WSControllerState waitStateChangeNotifications(WSControllerState previou * Enable resources runtime value notifications. * * @param resourceIdList List of resource Identifiers. - * @return True is connection successfully opened. */ public synchronized void enableRuntimeValueNotifications(Set resourceIdList) throws IhcExecption { resourceInteractionService.enableRuntimeValueNotifications(resourceIdList); @@ -422,7 +421,7 @@ public WSResourceValue resourceQuery(int resoureId) throws IhcExecption { * Resource value's value field (e.g. floatingPointValue) could be old * information. * - * @param resoureId Resource Identifier. + * @param resourceId Resource Identifier. * @return Resource value. */ public WSResourceValue getResourceValueInformation(int resourceId) throws IhcExecption { diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSNumberOfSegments.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSNumberOfSegments.java index 6835668fa6866..79dd717640573 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSNumberOfSegments.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSNumberOfSegments.java @@ -46,7 +46,7 @@ public int getNumberOfSegments() { /** * Sets the number of segmentations. * - * @param value + * @param segments */ public void setNumberOfSegments(int segments) { this.segments = segments; diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSRFDevice.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSRFDevice.java index 93bd267f67e08..06663d44b5acf 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSRFDevice.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSRFDevice.java @@ -69,7 +69,7 @@ public int getDeviceType() { /** * Sets the device type value for this WSRFDevice. * - * @param device type + * @param deviceType device type */ public void setDeviceType(int deviceType) { this.deviceType = deviceType; @@ -87,7 +87,7 @@ public long getSerialNumber() { /** * Sets the serial number value for this WSRFDevice. * - * @param Serial number + * @param serialNumber Serial number */ public void setSerialNumber(long serialNumber) { this.serialNumber = serialNumber; diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSSystemInfo.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSSystemInfo.java index 18b8262b63ebd..c4a7cb5dcdef5 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSSystemInfo.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSSystemInfo.java @@ -90,7 +90,7 @@ public ZonedDateTime getRealTimeClock() { /** * Sets the RealTimeClock value for this WSSystemInfo. * - * @param RealTimeClock + * @param realtimeclock */ public void setRealTimeClock(ZonedDateTime realtimeclock) { this.realtimeclock = realtimeclock; @@ -108,7 +108,7 @@ public String getSerialNumber() { /** * Sets the SerialNumber value for this WSSystemInfo. * - * @param SerialNumber + * @param serialNumber */ public void setSerialNumber(String serialNumber) { this.serialNumber = serialNumber; diff --git a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSUser.java b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSUser.java index da7fbb5064a3a..d4bbd23f521d0 100644 --- a/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSUser.java +++ b/bundles/org.openhab.binding.ihc/src/main/java/org/openhab/binding/ihc/internal/ws/datatypes/WSUser.java @@ -159,9 +159,6 @@ public String getFirstname() { /** * Sets the value of the firstname property. - * - * @return possible object is {@link String } - * */ public void setFirstname(String value) { this.firstname = value; @@ -189,9 +186,6 @@ public void setLastname(String value) { /** * Gets the value of the phone property. - * - * @param value allowed object is {@link String } - * */ public String getPhone() { return phone; 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 cc21456d20189..aa2536afaa9ed 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 @@ -407,7 +407,6 @@ private boolean doResourceUpdate(String query) throws IhcExecption { * Enable resources runtime value notifications. * * @param resourceIdList List of resource Identifiers. - * @return True is connection successfully opened. */ public void enableRuntimeValueNotifications(Set resourceIdList) throws IhcExecption { // @formatter:off @@ -444,7 +443,7 @@ public void enableRuntimeValueNotifications(Set resourceIdList) throws * @param timeoutInSeconds How many seconds to wait notifications. * @return List of received runtime value notifications. * @throws SocketTimeoutException - * @throws IhcTimeoutExecption + * @throws IhcExecption */ public List waitResourceValueNotifications(int timeoutInSeconds) throws IhcExecption { // @formatter:off diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/DeviceFeatureListener.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/DeviceFeatureListener.java index 84794ae5788b4..63454d02ffa8f 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/DeviceFeatureListener.java +++ b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/DeviceFeatureListener.java @@ -54,9 +54,9 @@ public enum StateChangeType { /** * Constructor * - * @param item name of the item that is listening + * @param binding * @param channelUID channel associated with this item - * @param eventPublisher the publisher to use for publishing on the openhab bus + * @param item name of the item that is listening */ public DeviceFeatureListener(InsteonBinding binding, ChannelUID channelUID, String item) { this.binding = binding; diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonDevice.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonDevice.java index 9c056b74b5f19..eba3b63e09c92 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonDevice.java +++ b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/InsteonDevice.java @@ -328,7 +328,7 @@ public void handleMessage(Msg msg) { * @param cmd2 * @return standard message * @throws FieldException - * @throws IOException + * @throws InvalidMessageTypeException */ public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2) throws FieldException, InvalidMessageTypeException { @@ -344,7 +344,7 @@ public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2) * @param group (-1 if not a group message) * @return standard message * @throws FieldException - * @throws IOException + * @throws InvalidMessageTypeException */ public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2, int group) throws FieldException, InvalidMessageTypeException { @@ -381,7 +381,7 @@ public Msg makeX10Message(byte rawX10, byte X10Flag) throws FieldException, Inva * @param cmd2 * @return extended message * @throws FieldException - * @throws IOException + * @throws InvalidMessageTypeException */ public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2) throws FieldException, InvalidMessageTypeException { @@ -397,7 +397,7 @@ public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2) * @param data array with userdata * @return extended message * @throws FieldException - * @throws IOException + * @throws InvalidMessageTypeException */ public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2, byte[] data) throws FieldException, InvalidMessageTypeException { @@ -420,7 +420,7 @@ public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2, byte[] data) * @param data array with user data * @return extended message * @throws FieldException - * @throws IOException + * @throws InvalidMessageTypeException */ public Msg makeExtendedMessageCRC2(byte flags, byte cmd1, byte cmd2, byte[] data) throws FieldException, InvalidMessageTypeException { @@ -503,7 +503,7 @@ public void enqueueMessage(Msg m, DeviceFeature f) { * * @param m message to be sent * @param f device feature that sent this message (so we can associate the response message with it) - * @param d time (in milliseconds)to delay before enqueuing message + * @param delay time (in milliseconds) to delay before enqueuing message */ public void enqueueDelayedMessage(Msg m, DeviceFeature f, long delay) { long now = System.currentTimeMillis(); diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/MessageHandler.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/MessageHandler.java index f7568bd6d6ab4..829de51673095 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/MessageHandler.java +++ b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/device/MessageHandler.java @@ -292,7 +292,7 @@ protected boolean isDuplicate(Msg msg) { * Extract button information from message * * @param msg the message to extract from - * @param the device feature (needed for debug printing) + * @param f the device feature (needed for debug printing) * @return the button number or -1 if no button found */ protected static int getButtonInfo(Msg msg, DeviceFeature f) { diff --git a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/Msg.java b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/Msg.java index fcf31c9848144..ed749418818f8 100644 --- a/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/Msg.java +++ b/bundles/org.openhab.binding.insteon/src/main/java/org/openhab/binding/insteon/internal/message/Msg.java @@ -324,7 +324,7 @@ public byte getByte(String key) throws FieldException { * Will fetch a byte array starting at a certain field * * @param key the name of the first field - * @param number of bytes to get + * @param numBytes of bytes to get * @return the byte array */ public byte[] getBytes(String key, int numBytes) throws FieldException { @@ -369,7 +369,7 @@ public String toHexString() { /** * Sets the userData fields from a byte array * - * @param data + * @param arg */ public void setUserData(byte[] arg) { byte[] data = Arrays.copyOf(arg, 14); // appends zeros if short @@ -569,7 +569,7 @@ public static boolean isExtended(byte[] buf, int len, int headerLength) { * * @param type the type of message to create, as defined in the xml file * @return reference to message created - * @throws IOException if there is no such message type known + * @throws InvalidMessageTypeException if there is no such message type known */ public static Msg makeMessage(String type) throws InvalidMessageTypeException { Msg m = MSG_MAP.get(type); diff --git a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/IntesisHomeHttpApi.java b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/IntesisHomeHttpApi.java index 19bf1561b6722..77bd446706d7e 100644 --- a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/IntesisHomeHttpApi.java +++ b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/IntesisHomeHttpApi.java @@ -48,7 +48,7 @@ public IntesisHomeHttpApi(IntesisHomeConfiguration config, HttpClient httpClient * Used to post a request to the device * * @param ipAddress of the device - * @param content string + * @param contentString string * @return JSON string as response */ @Nullable diff --git a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/MessageReceivedEvent.java b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/MessageReceivedEvent.java index b09270a554208..fedd79591b7b4 100644 --- a/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/MessageReceivedEvent.java +++ b/bundles/org.openhab.binding.intesis/src/main/java/org/openhab/binding/intesis/internal/api/MessageReceivedEvent.java @@ -16,7 +16,8 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link DataPointChangedEvent} is an event container for data point changes + * The {@link org.openhab.binding.ism8.server.DataPointChangedEvent} + * is an event container for data point changes * * @author Hans-Jörg Merk - Initial contribution */ diff --git a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8BindingConstants.java b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8BindingConstants.java index 46f43c024d98a..010fdd48c8e7a 100644 --- a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8BindingConstants.java +++ b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8BindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link ism8BindingConstants} class defines common constants, which are + * The {@link Ism8BindingConstants} class defines common constants, which are * used across the whole binding. * * @author Hans-Reiner Hoffmann - Initial contribution diff --git a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8Configuration.java b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8Configuration.java index 55549e5ab48ac..3ad12ad26e717 100644 --- a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8Configuration.java +++ b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8Configuration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link ism8Configuration} class contains fields mapping thing configuration parameters. + * The {@link Ism8Configuration} class contains fields mapping thing configuration parameters. * * @author Hans-Reiner Hoffmann - Initial contribution */ diff --git a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8HandlerFactory.java b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8HandlerFactory.java index fb87db9a6d27d..a2c8901994f6d 100644 --- a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8HandlerFactory.java +++ b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/internal/Ism8HandlerFactory.java @@ -27,7 +27,7 @@ import org.osgi.service.component.annotations.Component; /** - * The {@link ism8HandlerFactory} is responsible for creating things and thing + * The {@link Ism8HandlerFactory} is responsible for creating things and thing * handlers. * * @author Hans-Reiner Hoffmann - Initial contribution diff --git a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/server/Server.java b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/server/Server.java index 3d78dc4fb178a..3c5802f84e96e 100644 --- a/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/server/Server.java +++ b/bundles/org.openhab.binding.ism8/src/main/java/org/openhab/binding/ism8/server/Server.java @@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link ism8Server} is responsible for listening to the Ism8 information + * The {@link Server} is responsible for listening to the Ism8 information * * @author Hans-Reiner Hoffmann - Initial contribution */ diff --git a/bundles/org.openhab.binding.juicenet/src/main/java/org/openhab/binding/juicenet/internal/api/dto/JuiceNetApiDeviceChargingStatus.java b/bundles/org.openhab.binding.juicenet/src/main/java/org/openhab/binding/juicenet/internal/api/dto/JuiceNetApiDeviceChargingStatus.java index d0b9c7b9d6aed..b630f9989ef18 100644 --- a/bundles/org.openhab.binding.juicenet/src/main/java/org/openhab/binding/juicenet/internal/api/dto/JuiceNetApiDeviceChargingStatus.java +++ b/bundles/org.openhab.binding.juicenet/src/main/java/org/openhab/binding/juicenet/internal/api/dto/JuiceNetApiDeviceChargingStatus.java @@ -17,7 +17,7 @@ import com.google.gson.annotations.SerializedName; /** - * {@link JuiceNetDeviceChargingStatus } implements DTO for device charging status + * {@link JuiceNetApiDeviceChargingStatus } implements DTO for device charging status * * @author Jeff James - Initial contribution */ diff --git a/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/KebaBindingConstants.java b/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/KebaBindingConstants.java index 1caaf978e18cb..18841e88a040d 100644 --- a/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/KebaBindingConstants.java +++ b/bundles/org.openhab.binding.keba/src/main/java/org/openhab/binding/keba/internal/KebaBindingConstants.java @@ -20,7 +20,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link KebaBinding} class defines common constants, which are used across + * The {@link KebaBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/KM200BindingConstants.java b/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/KM200BindingConstants.java index 591221fe88d05..1e1100023abd8 100644 --- a/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/KM200BindingConstants.java +++ b/bundles/org.openhab.binding.km200/src/main/java/org/openhab/binding/km200/internal/KM200BindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link km200Binding} class defines common constants, which are + * The {@link KM200BindingConstants} class defines common constants, which are * used across the whole binding. * * @author Markus Eckhardt - Initial contribution 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 624a719fb0b96..0f5de787cc8bf 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 @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link KodiBinding} class defines common constants, which are used across + * The {@link KodiBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Paul Frank - Initial contribution diff --git a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedConfiguration.java b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedConfiguration.java index 3eda20d0ef36b..035bedaaf6092 100644 --- a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedConfiguration.java +++ b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedConfiguration.java @@ -22,9 +22,12 @@ public class KonnectedConfiguration extends Configuration { /** - * @param blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands - * @param discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP + * blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands. */ public boolean blink; + + /** + * discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP. + */ public boolean discovery; } diff --git a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedHTTPUtils.java b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedHTTPUtils.java index 96282f69b0b50..3dfbf5160bcff 100644 --- a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedHTTPUtils.java +++ b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/KonnectedHTTPUtils.java @@ -96,7 +96,7 @@ private synchronized String doGet(String urlAddress, String payload) throws IOEx * * @param urlAddress the address to send the request * @param payload the json payload you want to send as part of the request, may be null. - * @param retry the number of retries before throwing the IOexpcetion back to the handler + * @param retryCount the number of retries before throwing the IOexpcetion back to the handler */ public synchronized String doGet(String urlAddress, String payload, int retryCount) throws KonnectedHttpRetryExceeded { @@ -126,7 +126,7 @@ public synchronized String doGet(String urlAddress, String payload, int retryCou * * @param urlAddress the address to send the request * @param payload the json payload you want to send as part of the request - * @param retry the number of retries before throwing the IOexpcetion back to the handler + * @param retryCount the number of retries before throwing the IOexpcetion back to the handler */ public synchronized String doPut(String urlAddress, String payload, int retryCount) throws KonnectedHttpRetryExceeded { diff --git a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/ZoneConfiguration.java b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/ZoneConfiguration.java index 6176bfe49ef30..4a1643b761878 100644 --- a/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/ZoneConfiguration.java +++ b/bundles/org.openhab.binding.konnected/src/main/java/org/openhab/binding/konnected/internal/ZoneConfiguration.java @@ -18,7 +18,7 @@ /** * The {@link ZoneConfiguration} class contains the configuration parameters for the zone. * - * @author Haavar Valeur + * @author Haavar Valeur - Initial contribution */ @NonNullByDefault public class ZoneConfiguration { 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 271b696b29ded..05627ea75655c 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 @@ -65,10 +65,7 @@ public class KonnectedHandler extends BaseThingHandler { * This is the constructor of the Konnected Handler. * * @param thing the instance of the Konnected thing - * @param webHookServlet the instance of the callback servlet that is running for communication with the Konnected - * Module - * @param hostAddress the webaddress of the openHAB server instance obtained by the runtime - * @param port the port on which the openHAB instance is running that was obtained by the runtime. + * @param callbackUrl the webaddress of the openHAB server instance obtained by the runtime */ public KonnectedHandler(Thing thing, String callbackUrl) { super(thing); diff --git a/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java b/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java index c3e8a8a65b163..d971e414e75d4 100644 --- a/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java +++ b/bundles/org.openhab.binding.kostalinverter/src/main/java/org/openhab/binding/kostalinverter/internal/secondgeneration/SecondGenerationDxsEntriesContainerDTO.java @@ -15,7 +15,7 @@ import java.util.List; /** - * The {@link SecondGenerationDxsEntriesContainer} class defines a Container, which is + * The {@link SecondGenerationDxsEntriesContainerDTO} class defines a Container, which is * used in the second generation part of the binding. * * @author Örjan Backsell - Initial contribution Piko1020, Piko New Generation diff --git a/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/LaMetricTimeBindingConstants.java b/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/LaMetricTimeBindingConstants.java index 378ec8ce8e8e1..017d9f87e893a 100644 --- a/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/LaMetricTimeBindingConstants.java +++ b/bundles/org.openhab.binding.lametrictime/src/main/java/org/openhab/binding/lametrictime/internal/LaMetricTimeBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link LaMetricTimeBinding} class defines common constants, which are + * The {@link LaMetricTimeBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Gregory Moyer - Initial contribution diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleActions.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleActions.java index 58be740ce77c0..7e39d871ea30e 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleActions.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleActions.java @@ -161,7 +161,7 @@ public void sendDynamicText( /** * Start an lcn relay timer with the given duration [ms] * - * @param relaynumber 1-based number of the relay to use + * @param relayNumber 1-based number of the relay to use * @param duration duration of the relay timer in milliseconds */ @RuleAction(label = "start a relay timer", description = "Start an LCN relay timer.") @@ -178,7 +178,7 @@ public void startRelayTimer( /** * Let the beeper connected to the LCN module beep. * - * @param volume sound volume in percent. Can be null. Then, the last volume is used. + * @param soundVolume sound volume in percent. Can be null. Then, the last volume is used. * @param tonality N=normal, S=special, 1-7 tonalities 1-7. Can be null. Then, normal tonality is used. * @param count number of beeps. Can be null. Then, number of beeps is one. */ diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java index 5d105cd60c407..734b93dbb2f15 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/LcnModuleHandler.java @@ -354,9 +354,9 @@ public void updateSerialNumberProperty(String serialNumber) { } /** - * Updates the LCN module's serial number property. + * Updates the LCN module's firmware version property. * - * @param serialNumber the new serial number + * @param firmwareVersion the new firmware version */ public void updateFirmwareVersionProperty(String firmwareVersion) { updateProperty(Thing.PROPERTY_FIRMWARE_VERSION, firmwareVersion); diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnAddr.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnAddr.java index ad624385de9fd..8677add675727 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnAddr.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnAddr.java @@ -49,7 +49,8 @@ public int getSegmentId() { * Gets the physical segment id ("local" segment replaced with 0). * Can be used to send data into the LCN bus. * - * @param localSegegmentId the segment id of the local segment (managed by {@link Connection}) + * @param localSegegmentId the segment id of the local segment (managed by + * {@link org.openhab.binding.lcn.internal.connection.Connection}) * @return the physical segment id */ public int getPhysicalSegmentId(int localSegegmentId) { diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnDefs.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnDefs.java index 75a623f5218ff..fe15006136917 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnDefs.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/LcnDefs.java @@ -160,7 +160,7 @@ public enum KeyTable { /** * Generates an array of booleans from an input integer (actually a byte). * - * @param input the input byte (0..255) + * @param inputByte the input byte (0..255) * @return the array of 8 booleans * @throws IllegalArgumentException if input is out of range (not a byte) */ diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/PckGenerator.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/PckGenerator.java index 09ae5fc4e1245..5fa7ebd2f7784 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/PckGenerator.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/PckGenerator.java @@ -34,7 +34,8 @@ public final class PckGenerator { /** * Generates a keep-alive. * LCN-PCHK will close the connection if it does not receive any commands from - * an open {@link Connection} for a specific period (10 minutes by default). + * an open {@link org.openhab.binding.lcn.internal.connection.Connection} for a specific period + * (10 minutes by default). * * @param counter the current ping's id (optional, but "best practice"). Should start with 1 * @return the PCK command as text @@ -177,7 +178,7 @@ public static String dimAllOutputs(double firstPercent, double secondPercent, do * Generates a control command for switching all outputs ON or OFF with a fixed ramp of 0.5s. * * @param percent 0..100 - * @returnthe PCK command (without address header) as text + * @return the PCK command (without address header) as text */ public static String controlAllOutputs(double percent) { return String.format("AH%03d", Math.round(percent)); @@ -398,7 +399,6 @@ public static String requestBinSensorsStatus() { * @param number regulator number 0..1 * @param value the absolute value to set * @return the PCK command (without address header) as text - * @throws LcnException */ public static String setSetpointAbsolute(int number, int value) { int internalValue = value; @@ -447,7 +447,6 @@ public static String setRVarMode(int number, boolean cooling) throws LcnExceptio * @param type the reference-point * @param value the native LCN value to add/subtract (can be negative) * @return the PCK command (without address header) as text - * @throws LcnException if command is not supported */ public static String setVariableRelative(Variable variable, LcnDefs.RelVarRef type, int value) { if (variable.getNumber() == 0) { @@ -844,7 +843,8 @@ public static String setBeepVolume(double volume) throws LcnException { /** * Generates a command to let the beeper connected to the LCN module beep. * - * @param volume the sound volume + * @param tonality N=normal, S=special, 1-7 tonalities 1-7. + * @param count count number of beeps. * @return the PCK command (without address header) as text * @throws LcnException if out of range */ diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/Variable.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/Variable.java index 3b929c61553bc..276989731027b 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/Variable.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/common/Variable.java @@ -240,8 +240,7 @@ public boolean isEventBased(int firmwareVersion) { * Checks if the target LCN module would automatically send status-updates if * the given variable type was changed by command. * - * @param variable the variable type to check - * @param is2013 the target module's-generation + * @param firmwareVersion * @return true if a poll is required to get the new status-value */ @SuppressWarnings("PMD.SimplifyBooleanReturns") diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/connection/Connection.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/connection/Connection.java index 58657cd36d70f..75e2a6578c212 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/connection/Connection.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/connection/Connection.java @@ -407,7 +407,7 @@ public void setSocketChannel(AsynchronousSocketChannel channel) { /** * Gets the SocketChannel of the Connection. * - * @returnthe socket channel + * @return the socket channel */ @Nullable public Channel getSocketChannel() { diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/Converter.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/Converter.java index 5b0d3fb32da5b..eb20491621be3 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/Converter.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/Converter.java @@ -49,7 +49,7 @@ public DecimalType onCommandFromItem(double humanReadable) { /** * Converts a human readable value into LCN native value. * - * @param humanReadable value to convert + * @param quantityType value to convert * @return the native LCN value * @throws LcnException when the value could not be converted to the base unit */ diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/ValueConverter.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/ValueConverter.java index 925fff97f9ebd..feaeb333dc055 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/ValueConverter.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/converter/ValueConverter.java @@ -74,7 +74,7 @@ public DecimalType onCommandFromItem(double humanReadable) { /** * Converts a human readable value into LCN native value. * - * @param humanReadable value to convert + * @param quantityType value to convert * @return the native LCN value * @throws LcnException when the value could not be converted to the base unit */ diff --git a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/subhandler/AbstractLcnModuleSubHandler.java b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/subhandler/AbstractLcnModuleSubHandler.java index ecb8547ec9fb0..deebb56ba3747 100644 --- a/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/subhandler/AbstractLcnModuleSubHandler.java +++ b/bundles/org.openhab.binding.lcn/src/main/java/org/openhab/binding/lcn/internal/subhandler/AbstractLcnModuleSubHandler.java @@ -117,7 +117,6 @@ private void unsupportedCommand(Command command) { * message. * * @param pck the message to process - * @return true, if the message could be processed successfully */ public void tryParse(String pck) { getPckStatusMessagePatterns().stream() // diff --git a/bundles/org.openhab.binding.lgtvserial/src/main/java/org/openhab/binding/lgtvserial/internal/LgTvSerialBindingConstants.java b/bundles/org.openhab.binding.lgtvserial/src/main/java/org/openhab/binding/lgtvserial/internal/LgTvSerialBindingConstants.java index 539c7c4efb2ba..e6b916e1c8f74 100644 --- a/bundles/org.openhab.binding.lgtvserial/src/main/java/org/openhab/binding/lgtvserial/internal/LgTvSerialBindingConstants.java +++ b/bundles/org.openhab.binding.lgtvserial/src/main/java/org/openhab/binding/lgtvserial/internal/LgTvSerialBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link LgTvSerialBinding} class defines common constants, which are + * The {@link LgTvSerialBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Marius Bjoernstad - Initial contribution diff --git a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/BaseChannelHandler.java b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/BaseChannelHandler.java index 5fc23204aadf6..16a611988ea4e 100644 --- a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/BaseChannelHandler.java +++ b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/BaseChannelHandler.java @@ -78,8 +78,7 @@ public final synchronized void refreshSubscription(String channelId, LGWebOSHand /** * Creates a subscription instance for this device if subscription is supported. * - * @param device device to which state changes to subscribe to - * @param channelID channel ID + * @param channelId channel ID * @param handler * @return an {@code Optional} containing the ServiceSubscription, or an empty {@code Optional} if subscription is * not supported. diff --git a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/WakeOnLanUtility.java b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/WakeOnLanUtility.java index 426c191dca7e6..5d3deed3b502b 100644 --- a/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/WakeOnLanUtility.java +++ b/bundles/org.openhab.binding.lgwebos/src/main/java/org/openhab/binding/lgwebos/internal/WakeOnLanUtility.java @@ -102,7 +102,7 @@ public class WakeOnLanUtility { /** * Send single WOL (Wake On Lan) package on all interfaces * - * @macAddress MAC address to send WOL package to + * @param macAddress MAC address to send WOL package to */ public static void sendWOLPacket(String macAddress) { byte[] bytes = getWOLPackage(macAddress); diff --git a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxBindingConstants.java b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxBindingConstants.java index c9addb9bbd894..4e25e6555ac55 100644 --- a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxBindingConstants.java +++ b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/LifxBindingConstants.java @@ -22,7 +22,7 @@ import org.openhab.core.thing.type.ChannelTypeUID; /** - * The {@link LifxBinding} class defines common constants, which are used across + * The {@link LifxBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Dennis Nobel - Initial contribution 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 21c93a8d8741a..c7b585888add0 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 @@ -40,7 +40,7 @@ public double getMilliWatts() { *
  • RSSI <= -100: returns 0 *
  • -100 < RSSI < -50: returns a value between 0 and 1 (linearly distributed) *
  • RSSI >= -50: returns 1 - *
      + *
    * * @return a value between 0 and 1. 0 being worst strength and 1 * being best strength. diff --git a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/listener/LifxPropertiesUpdateListener.java b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/listener/LifxPropertiesUpdateListener.java index b990eb1c1ea0e..e76c9b239065c 100644 --- a/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/listener/LifxPropertiesUpdateListener.java +++ b/bundles/org.openhab.binding.lifx/src/main/java/org/openhab/binding/lifx/internal/listener/LifxPropertiesUpdateListener.java @@ -29,7 +29,7 @@ public interface LifxPropertiesUpdateListener { /** * Called when the {@link LifxLightPropertiesUpdater} has updated light properties. * - * @param packet the updated properties + * @param properties the updated properties */ void handlePropertiesUpdate(Map properties); } diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCBindingConstants.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCBindingConstants.java index c974d2cac65c1..f154405cc5ec6 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCBindingConstants.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCBindingConstants.java @@ -19,7 +19,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link LIRCBinding} class defines common constants, which are + * The {@link LIRCBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Andrew Nagle - Initial contribution diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCMessageListener.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCMessageListener.java index 9992896ab3e11..8952005a74b35 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCMessageListener.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCMessageListener.java @@ -19,7 +19,7 @@ /** * Interface for listeners to receive messages from LIRC server * - * @author Andrew Nagle + * @author Andrew Nagle - Initial contribution */ public interface LIRCMessageListener { diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCResponseException.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCResponseException.java index da1781ae903cf..bae397dd2d5de 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCResponseException.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/LIRCResponseException.java @@ -15,7 +15,7 @@ /** * Exceptions thrown from the serial interface. * - * @author Andrew Nagle - Initial contributor + * @author Andrew Nagle - Initial contribution */ public class LIRCResponseException extends Exception { diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCBridgeConfiguration.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCBridgeConfiguration.java index 9ea477f93418c..926e4b3824575 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCBridgeConfiguration.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCBridgeConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.lirc.internal.config; /** - * Configuration class for {@link LIRCBridge} device. + * Configuration class for LIRCBridge device. * * @author Andrew Nagle - Initial contribution */ diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCRemoteConfiguration.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCRemoteConfiguration.java index 7279f4afe97d8..926361f7c1fd3 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCRemoteConfiguration.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/config/LIRCRemoteConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.lirc.internal.config; /** - * Configuration class for {@link LIRCRemote} device. + * Configuration class for LIRCRemote device. * * @author Andrew Nagle - Initial contribution */ diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCConnector.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCConnector.java index 13a21442bde60..f584b04eed60c 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCConnector.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCConnector.java @@ -30,7 +30,7 @@ /** * Connector for communication with the LIRC server * - * @author Andrew Nagle - Initial contributor + * @author Andrew Nagle - Initial contribution */ public class LIRCConnector { diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCEventListener.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCEventListener.java index b2d7cef37e971..9a2e1a55c6417 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCEventListener.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCEventListener.java @@ -18,14 +18,14 @@ /** * Defines an interface to receive messages from the LIRC server * - * @author Andrew Nagle + * @author Andrew Nagle - Initial contribution */ public interface LIRCEventListener { /** * Procedure to receive messages from the LIRC server * - * @param reponse + * @param message * Message received */ void messageReceived(LIRCResponse message); diff --git a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCStreamReader.java b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCStreamReader.java index 261c0595f93d3..29c0f9db93a6c 100644 --- a/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCStreamReader.java +++ b/bundles/org.openhab.binding.lirc/src/main/java/org/openhab/binding/lirc/internal/connector/LIRCStreamReader.java @@ -31,7 +31,7 @@ /** * Stream reader to parse LIRC output into messages * - * @author Andrew Nagle + * @author Andrew Nagle - Initial contribution */ public class LIRCStreamReader extends Thread { diff --git a/bundles/org.openhab.binding.logreader/src/main/java/org/openhab/binding/logreader/internal/config/LogReaderConfiguration.java b/bundles/org.openhab.binding.logreader/src/main/java/org/openhab/binding/logreader/internal/config/LogReaderConfiguration.java index 226eda9dd007e..4207739807fd8 100644 --- a/bundles/org.openhab.binding.logreader/src/main/java/org/openhab/binding/logreader/internal/config/LogReaderConfiguration.java +++ b/bundles/org.openhab.binding.logreader/src/main/java/org/openhab/binding/logreader/internal/config/LogReaderConfiguration.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * Configuration class for {@link LogReaderBinding} binding. + * Configuration class for LogReader binding. * * @author Pauli Anttila - Initial contribution */ diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/LutronBindingConstants.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/LutronBindingConstants.java index 1c786e58fc4d4..881a960fff51d 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/LutronBindingConstants.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/LutronBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link LutronBinding} class defines common constants, which are + * The {@link LutronBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Allan Tong - Initial contribution diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/GrafikEyeConfig.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/GrafikEyeConfig.java index c430e9c84c424..cd8eb33026795 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/GrafikEyeConfig.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/grxprg/GrafikEyeConfig.java @@ -115,7 +115,7 @@ boolean isShadeZone(int zone) { /** * Returns a comma formatted list of shade zones * - * @returna non-null, non-empty comma delimited list of shade zones + * @return a non-null, non-empty comma delimited list of shade zones */ public String getShadeZones() { final StringBuilder sb = new StringBuilder(); diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwDimmerConfig.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwDimmerConfig.java index 1ed319412fc24..84f0b6ba5d4b7 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwDimmerConfig.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwDimmerConfig.java @@ -13,7 +13,7 @@ package org.openhab.binding.lutron.internal.hw; /** - * Configuration settings for a {@link org.openhab.binding.lutron.handler.HWDimmerHandler}. + * Configuration settings for a {@link org.openhab.binding.lutron.internal.hw.HwDimmerHandler}. * * @author Andrew Shilliday - Initial contribution */ diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwSerialBridgeConfig.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwSerialBridgeConfig.java index 5975a4ca69acb..2a21a84546003 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwSerialBridgeConfig.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/hw/HwSerialBridgeConfig.java @@ -13,7 +13,7 @@ package org.openhab.binding.lutron.internal.hw; /** - * Configuration settings for an {@link org.openhab.binding.lutron.handler.HWSerialBridgeHandler}. + * Configuration settings for an {@link org.openhab.binding.lutron.internal.hw.HwSerialBridgeHandler}. * * @author Andrew Shilliday - Initial contribution */ diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/GroupCommand.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/GroupCommand.java index a4be2efe1d813..df1f94ae03f83 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/GroupCommand.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/GroupCommand.java @@ -39,7 +39,6 @@ public class GroupCommand extends LutronCommandNew { /** * GroupCommand constructor * - * @param targetType * @param operation * @param integrationId * @param action diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/SysvarCommand.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/SysvarCommand.java index 61bb286e69a53..f76f155f7aa4a 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/SysvarCommand.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/SysvarCommand.java @@ -35,7 +35,6 @@ public class SysvarCommand extends LutronCommandNew { /** * SysvarCommand constructor * - * @param targetType * @param operation * @param integrationId * @param action diff --git a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/TimeclockCommand.java b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/TimeclockCommand.java index 77331a808f173..6c3a59b5e94ae 100644 --- a/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/TimeclockCommand.java +++ b/bundles/org.openhab.binding.lutron/src/main/java/org/openhab/binding/lutron/internal/protocol/TimeclockCommand.java @@ -42,7 +42,6 @@ public class TimeclockCommand extends LutronCommandNew { /** * TimeclockCommand constructor * - * @param targetType * @param operation * @param integrationId * @param action diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/MagentaTVHandlerFactory.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/MagentaTVHandlerFactory.java index 50c8fe26b9fb0..034af7536f9d9 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/MagentaTVHandlerFactory.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/MagentaTVHandlerFactory.java @@ -108,15 +108,6 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) { return null; } - /** - * Add a device to the device table - * - * @param udn UDN for the device - * @param deviceId A unique device id - * @param ipAddress IP address of the receiver - * @param handler The corresponding thing handler - */ - public void setNotifyServletStatus(boolean newStatus) { logger.debug("NotifyServlet started"); servletInitialized = newStatus; 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 eea05062525cc..c47d0b97959c7 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 @@ -219,7 +219,7 @@ public void subscribeEventChannel() throws MagentaTVException { * $friendlyName\n $userID\n * \n * - * @returns true: pairing successful + * @return true: pairing successful * @throws MagentaTVException */ public boolean sendPairingRequest() throws MagentaTVException { diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java index b6e5133cf15a6..ec27f950ea0d3 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java @@ -101,8 +101,10 @@ public class MagentaTVHandler extends BaseThingHandler implements MagentaTVListe /** * Constructor, save bindingConfig (services as default for thingConfig) * + * @param manager * @param thing - * @param bindingConfig + * @param network + * @param httpClient */ public MagentaTVHandler(MagentaTVDeviceManager manager, Thing thing, MagentaTVNetwork network, HttpClient httpClient) { @@ -376,8 +378,8 @@ private void getUserId() throws MagentaTVException { /** * Update thing status * - * @param mode new thing status - * @return ON = power on, OFF=power off + * @param newStatus new thing status + * @param errorMessage */ public void setOnlineStatus(ThingStatus newStatus, String errorMessage) { ThingStatus status = this.getThing().getStatus(); diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVHttp.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVHttp.java index 1ae9434e88d2b..0411d74cc48de 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVHttp.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVHttp.java @@ -66,8 +66,9 @@ public String httpGet(String host, String urlBase, String urlParameters) throws * Given a URL and a set parameters, send a HTTP POST request to the URL * location created by the URL and parameters. * + * @param host * @param url The URL to send a POST request to. - * @param urlParameters List of parameters to use in the URL for the POST + * @param postData List of parameters to use in the URL for the POST * request. Null if no parameters. * @param soapAction Header attribute for SOAP ACTION: xxx * @param connection Header attribut for CONNECTION: xxx @@ -107,7 +108,7 @@ public String httpPOST(String host, String url, String postData, String soapActi * @param remotePort destination port * @param data data to send * @return received response - * @throws IOException + * @throws MagentaTVException */ public String sendData(String remoteIp, String remotePort, String data) throws MagentaTVException { String errorMessage = ""; diff --git a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNetwork.java b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNetwork.java index c4069d9875e80..37cc20f9214b0 100644 --- a/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNetwork.java +++ b/bundles/org.openhab.binding.magentatv/src/main/java/org/openhab/binding/magentatv/internal/network/MagentaTVNetwork.java @@ -43,8 +43,8 @@ public class MagentaTVNetwork { /** * Init local network interface, determine local IP and MAC address * - * @param networkAddressService - * @return + * @param localIP + * @param localPort */ public void initLocalNet(String localIP, String localPort) throws MagentaTVException { try { 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 667408174f68d..acdb484099d4b 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 @@ -82,7 +82,7 @@ public MagentaTVNotifyServlet(@Reference MagentaTVHandlerFactory handlerFactory, * STB_playContent> * * @param request - * @param resp + * @param response * * @throws ServletException, IOException */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/CCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/CCommand.java index 3e516637b3e8a..bdb6557b6748b 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/CCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/CCommand.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link C_CubeCommand} to request configuration of a new MAX! device after inclusion. + * The {@link CubeCommand} to request configuration of a new MAX! device after inclusion. * * @author Marcel Verpaalen - Initial Contribution */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/FCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/FCommand.java index 08763f0d371fb..964ad5c4317aa 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/FCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/FCommand.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link F_CubeCommand} is used to query and update the NTP servers used by the Cube. + * The {@link FCommand} is used to query and update the NTP servers used by the Cube. * * @author Marcel Verpaalen - Initial Contribution */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/NCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/NCommand.java index 93498237ed65b..bb3ba0f4150ff 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/NCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/NCommand.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link N_CubeCommand} starts the inclusion mode for new MAX! devices. + * The {@link NCommand} starts the inclusion mode for new MAX! devices. * * @author Marcel Verpaalen - Initial Contribution */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/TCommand.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/TCommand.java index 401235d386d0e..ce4a984b49ef9 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/TCommand.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/command/TCommand.java @@ -21,7 +21,7 @@ import org.openhab.binding.max.internal.Utils; /** - * The {@link T_CubeCommand} is used to unlink MAX! devices from the Cube. + * The {@link TCommand} is used to unlink MAX! devices from the Cube. * * @author Marcel Verpaalen - Initial Contribution */ 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 46bd30469eebd..1ff5ee389e8a1 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 @@ -84,7 +84,7 @@ public static Device create(String rfAddress, List configur /** * Creates a new device * - * @param DeviceConfiguration + * @param c * @return Device */ public static Device create(DeviceConfiguration c) { diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/DeviceStatusListener.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/DeviceStatusListener.java index 79a82754970b8..1e8d1a35d60e5 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/DeviceStatusListener.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/handler/DeviceStatusListener.java @@ -53,7 +53,7 @@ public interface DeviceStatusListener { /** * This method is called whenever a device config is updated. * - * @param bridgeThe MAX! Cube bridge the device was connected to + * @param bridge The MAX! Cube bridge the device was connected to * @param device The device which config is changed */ void onDeviceConfigUpdate(Bridge bridge, Device device); 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 0e2985ada1560..a3fdbff332714 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 @@ -927,7 +927,7 @@ public Device getDevice(String serialNumber) { * Max! Cube, they will be removed from the queue as they would not be * meaningful. This will improve the behavior when using sliders in the GUI. * - * @param SendCommand + * @param sendCommand * the SendCommand containing the serial number of the device as * String the channelUID used to send the command and the the * command data @@ -965,7 +965,7 @@ public void sendDeviceAndRoomNameUpdate(String comment) { /** * Delete a devices from the cube and updates the room information * - * @param Device Serial + * @param maxDeviceSerial Serial */ public void sendDeviceDelete(String maxDeviceSerial) { Device device = getDevice(maxDeviceSerial); diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/FMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/FMessage.java index 78e4e74a991f3..8c73738015414 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/FMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/FMessage.java @@ -16,7 +16,7 @@ import org.slf4j.Logger; /** - * The {@link: FMessage} contains information about the Cube NTP Configuration + * The {@link FMessage} contains information about the Cube NTP Configuration * This is the response to a f: command * * @author Marcel Verpaalen - Initial contribution @@ -28,7 +28,7 @@ public final class FMessage extends Message { private String ntpServer2 = ""; /** - * The {@link: FMessage} contains information about the Cube NTP Configuration + * The {@link FMessage} contains information about the Cube NTP Configuration * * @param raw String with raw message */ diff --git a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/NMessage.java b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/NMessage.java index 2801c5272eb03..c57df66edf62c 100644 --- a/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/NMessage.java +++ b/bundles/org.openhab.binding.max/src/main/java/org/openhab/binding/max/internal/message/NMessage.java @@ -23,7 +23,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link: NMessage} contains information about a newly discovered Device + * The {@link NMessage} contains information about a newly discovered Device * This is the response to a n: command * * @author Marcel Verpaalen - Initial contribution @@ -38,7 +38,7 @@ public final class NMessage extends Message { private String serialnr = ""; /** - * The {@link: NMessage} contains information about a newly discovered Device + * The {@link NMessage} contains information about a newly discovered Device * * @param raw String with raw message */ diff --git a/bundles/org.openhab.binding.mercedesme/src/main/java/org/openhab/binding/mercedesme/internal/handler/VehicleHandler.java b/bundles/org.openhab.binding.mercedesme/src/main/java/org/openhab/binding/mercedesme/internal/handler/VehicleHandler.java index 03e0fa8c30748..e377159d84caf 100644 --- a/bundles/org.openhab.binding.mercedesme/src/main/java/org/openhab/binding/mercedesme/internal/handler/VehicleHandler.java +++ b/bundles/org.openhab.binding.mercedesme/src/main/java/org/openhab/binding/mercedesme/internal/handler/VehicleHandler.java @@ -541,7 +541,7 @@ private void updateRadius() { * * This depends also on the roads of a concrete route but this is only a guess without any Route Navigation behind * - * @param range + * @param s * @return mapping from air-line distance to "real road" distance */ public static State guessRangeRadius(QuantityType s) { diff --git a/bundles/org.openhab.binding.meteostick/src/main/java/org/openhab/binding/meteostick/internal/MeteostickBindingConstants.java b/bundles/org.openhab.binding.meteostick/src/main/java/org/openhab/binding/meteostick/internal/MeteostickBindingConstants.java index 24e985244f5a6..9553cadb916c6 100644 --- a/bundles/org.openhab.binding.meteostick/src/main/java/org/openhab/binding/meteostick/internal/MeteostickBindingConstants.java +++ b/bundles/org.openhab.binding.meteostick/src/main/java/org/openhab/binding/meteostick/internal/MeteostickBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link meteostickBinding} class defines common constants, which are + * The {@link MeteostickBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Chris Jackson - Initial contribution 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 6fdd20907a0a3..e4af33ef4d33e 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 @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link MieleBinding} class defines common constants, which are + * The {@link MieleBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/discovery/MieleMDNSDiscoveryParticipant.java b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/discovery/MieleMDNSDiscoveryParticipant.java index 9bebd15c3c1cf..70caec5fa5c30 100644 --- a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/discovery/MieleMDNSDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/discovery/MieleMDNSDiscoveryParticipant.java @@ -38,7 +38,7 @@ /** * The {@link MieleMDNSDiscoveryParticipant} is responsible for discovering Miele XGW3000 Gateways. It uses the central - * {@link MDNSDiscoveryService}. + * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}. * * @author Karel Goderis - Initial contribution * @author Martin Lepsy - Added check for Miele gateway for cleaner discovery diff --git a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/ApplianceStatusListener.java b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/ApplianceStatusListener.java index 2aaf212df0c62..e956432f71a92 100644 --- a/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/ApplianceStatusListener.java +++ b/bundles/org.openhab.binding.miele/src/main/java/org/openhab/binding/miele/internal/handler/ApplianceStatusListener.java @@ -37,7 +37,7 @@ public interface ApplianceStatusListener { /** * This method is called whenever a "property" of the given appliance has changed. * - * @param dco the POJO containing the new state of the property + * @param dp the POJO containing the new state of the property */ void onAppliancePropertyChanged(DeviceProperty dp); diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/OAuthAuthorizationHandler.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/OAuthAuthorizationHandler.java index 504656f2042c9..61f97289f0bfc 100644 --- a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/OAuthAuthorizationHandler.java +++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/config/OAuthAuthorizationHandler.java @@ -42,7 +42,8 @@ public interface OAuthAuthorizationHandler { * service. * @return The authorization URL to which the user is redirected for the log in. * @throws NoOngoingAuthorizationException if there is no ongoing authorization. - * @throws OAuthException if the authorization URL cannot be determined. In this case the ongoing authorization is + * @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization URL cannot be determined. In this + * case the ongoing authorization is * cancelled. */ String getAuthorizationUrl(String redirectUri); @@ -65,7 +66,8 @@ public interface OAuthAuthorizationHandler { * @param redirectUrlWithParameters The URL the remote service redirected the user to. This is the URL our servlet * was called with. * @throws NoOngoingAuthorizationException if there is no ongoing authorization. - * @throws OAuthException if the authorization failed. In this case the ongoing authorization is cancelled. + * @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization failed. In this case the ongoing + * authorization is cancelled. */ void completeAuthorization(String redirectUrlWithParameters); @@ -74,7 +76,7 @@ public interface OAuthAuthorizationHandler { * * @param email E-mail address for which the access token is requested. * @return The access token. - * @throws OAuthException if the access token cannot be obtained. + * @throws org.openhab.core.auth.client.oauth2.OAuthException if the access token cannot be obtained. */ String getAccessToken(String email); } diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/handler/AbstractMieleThingHandler.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/handler/AbstractMieleThingHandler.java index b5b63b5bb6a64..928621d50a579 100644 --- a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/handler/AbstractMieleThingHandler.java +++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/handler/AbstractMieleThingHandler.java @@ -282,7 +282,7 @@ private void updateThingProperties(DeviceState deviceState) { /** * Updates the device action state channels. * - * @param action The {@link ActionsChannelState} information to update the action channel states with. + * @param actions The {@link ActionsChannelState} information to update the action channel states with. */ protected abstract void updateActionState(ActionsChannelState actions); } diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/DeviceStateListener.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/DeviceStateListener.java index 317fb36d96066..e935ab55b7c81 100644 --- a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/DeviceStateListener.java +++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/DeviceStateListener.java @@ -33,7 +33,7 @@ public interface DeviceStateListener { /** * Invoked when a new process action is available for a device. * - * @param ActionsState The action state information. + * @param actionState The action state information. */ void onProcessActionUpdated(ActionsState actionState); diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/MieleWebservice.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/MieleWebservice.java index dac351e324721..682a70b7bf8c3 100644 --- a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/MieleWebservice.java +++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/MieleWebservice.java @@ -92,7 +92,7 @@ public interface MieleWebservice extends AutoCloseable { * Performs a PUT operation setting the active program. * * @param deviceId ID of the device to trigger the action for. - * @param program The program to activate. + * @param programId The program to activate. * @throws MieleWebserviceException if an error occurs during webservice requests or content parsing. * @throws AuthorizationFailedException if the authorization against the webservice failed. * @throws TooManyRequestsException if too many requests have been made against the webservice recently. diff --git a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/api/json/ProcessAction.java b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/api/json/ProcessAction.java index dccf8e033ccec..0773327e7fd0f 100644 --- a/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/api/json/ProcessAction.java +++ b/bundles/org.openhab.binding.mielecloud/src/main/java/org/openhab/binding/mielecloud/internal/webservice/api/json/ProcessAction.java @@ -24,7 +24,7 @@ @NonNullByDefault public enum ProcessAction { /** - * {@StateType} for unknown states. + * {@link StateType} for unknown states. */ UNKNOWN, diff --git a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java index ad8aabb485fb9..6d758633c11ef 100644 --- a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java +++ b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java @@ -114,7 +114,7 @@ public static JsonObject convertFileToJSON(URL fileName) throws JsonIOException, * Saves string to file in userdata folder * * @param filename - * @param string with content + * @param data String with content * @param logger */ public static void saveToFile(String filename, String data, Logger logger) { diff --git a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudUtil.java b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudUtil.java index 491b0dda2aa67..8305d71c8feaa 100644 --- a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudUtil.java +++ b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudUtil.java @@ -72,11 +72,11 @@ public static void saveDeviceInfoFile(String data, String country, Logger logger /** * Generate signature for the request. * - * @param method http request method. GET or POST * @param requestUrl the full request url. e.g.: http://api.xiaomi.com/getUser?id=123321 + * @param signedNonce secret key for encryption. + * @param nonce * @param params request params. This should be a TreeMap because the * parameters are required to be in lexicographic order. - * @param signedNonce secret key for encryption. * @return hash value for the values provided * @throws MiIoCryptoException */ diff --git a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java index 342c0b43679ba..888c3683aeb95 100644 --- a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java +++ b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java @@ -275,7 +275,7 @@ protected int sendCommand(String commandString) { * between [] brackets. This to allow for unimplemented commands to be executed * * @param commandString command to be executed - * @param cloud server to be used or empty string for direct sending to the device + * @param cloudServer server to be used or empty string for direct sending to the device * @return message id */ protected int sendCommand(String commandString, String cloudServer) { @@ -300,9 +300,9 @@ protected int sendCommand(String command, String params, String cloudServer) { * Sends commands to the {@link MiIoAsyncCommunication} for transmission to the Mi devices or cloud * * @param command (method) to be queued for execution - * @param parameters to be send with the command - * @param cloud server to be used or empty string for direct sending to the device - * @param sending subdevice or empty string for regular device + * @param params to be send with the command + * @param cloudServer server to be used or empty string for direct sending to the device + * @param sender subdevice or empty string for regular device * @return message id */ protected int sendCommand(String command, String params, String cloudServer, String sender) { diff --git a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/miot/MiIoQuantiyTypesConversion.java b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/miot/MiIoQuantiyTypesConversion.java index a59308f9383ed..826d458ae0062 100644 --- a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/miot/MiIoQuantiyTypesConversion.java +++ b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/miot/MiIoQuantiyTypesConversion.java @@ -20,7 +20,7 @@ /** * Enum of the unitTypes used in the miio protocol - * Used to find the right {@link javax.measure.unitType} given the string of the unitType + * Used to find the right {@link javax.measure.Unit} given the string of the unitType * * @author Marcel Verpaalen - Initial contribution */ diff --git a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/MilightBindingConstants.java b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/MilightBindingConstants.java index 01e7678215e4d..36d7b45f36a22 100644 --- a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/MilightBindingConstants.java +++ b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/MilightBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link MilightBinding} class defines common constants, which are + * The {@link MilightBindingConstants} class defines common constants, which are * used across the whole binding. * * @author David Graeff - Initial contribution diff --git a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/discovery/MilightBridgeDiscovery.java b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/discovery/MilightBridgeDiscovery.java index 4907646884de6..0703e32f62d19 100644 --- a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/discovery/MilightBridgeDiscovery.java +++ b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/discovery/MilightBridgeDiscovery.java @@ -221,9 +221,6 @@ public void stop() { /** * Send a discover message and resends the message until either a valid response * is received or the resend counter reaches the maximum attempts. - * - * @param scheduler The scheduler is used for resending. - * @throws SocketException */ public void startDiscoveryService() { // Do nothing if there is already a discovery running diff --git a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractBridgeHandler.java b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractBridgeHandler.java index 441f20c6a44e0..8bfc969708610 100644 --- a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractBridgeHandler.java +++ b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractBridgeHandler.java @@ -63,8 +63,6 @@ public void handleConfigurationUpdate(Map configurationParameter /** * Creates a connection and other supportive objects. - * - * @param addr */ protected abstract void startConnectAndKeepAlive(); diff --git a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractLedHandler.java b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractLedHandler.java index 98a9e4b8e10b7..19e5dcad485c1 100644 --- a/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractLedHandler.java +++ b/bundles/org.openhab.binding.milight/src/main/java/org/openhab/binding/milight/internal/handler/AbstractLedHandler.java @@ -14,7 +14,6 @@ import java.net.DatagramSocket; import java.net.InetAddress; -import java.net.SocketException; import org.eclipse.jdt.annotation.NonNull; import org.eclipse.jdt.annotation.NonNullByDefault; @@ -68,10 +67,9 @@ public abstract class AbstractLedHandler extends BaseThingHandler implements Led /** * A bulb always belongs to a zone in the milight universe and we need a way to queue commands for being send. * - * @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset. + * @param thing * @param sendQueue The send queue. - * @param zone A zone, usually 0 means all bulbs of the same type. [0-4] - * @throws SocketException + * @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset. */ public AbstractLedHandler(Thing thing, QueuedSend sendQueue, int typeOffset) { super(thing); 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 0eb77637629d4..13d1e06b154ce 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 @@ -44,10 +44,10 @@ * with our own client session bytes included. * * The response will assign as session bytes that we can use for subsequent commands - * see {@link MilightV6SessionManager#sid1} and see {@link MilightV6SessionManager#sid2}. + * see {@link MilightV6SessionManager#clientSID1} and see {@link MilightV6SessionManager#clientSID2}. * * We register ourself to the bridge now and finalise the handshake by sending a register command - * see {@link MilightV6SessionManager#sendRegistration()} to the bridge. + * see {@link #sendRegistration(DatagramSocket)} to the bridge. * * From this point on we are required to send keep alive packets to the bridge every ~10sec * to keep the session alive. Because each command we send is confirmed by the bridge, we know if @@ -158,10 +158,8 @@ public interface ISessionState { * A session manager for the V6 bridge needs a way to send data (a QueuedSend object), the destination bridge ID, a * scheduler for timeout timers and optionally an observer for session state changes. * - * @param sendQueue A send queue. Never remove or change that object while the session manager is still working. * @param bridgeId Destination bridge ID. If the bridge ID for whatever reason changes, you need to create a new * session manager object - * @param scheduler A framework scheduler to create timeout events. * @param observer Get notifications of state changes * @param destIP If you know the bridge IP address, provide it here. * @param port The bridge port diff --git a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/MinecraftBindingConstants.java b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/MinecraftBindingConstants.java index 0e456cdbf414f..40998fbd11e7b 100644 --- a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/MinecraftBindingConstants.java +++ b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/MinecraftBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link MinecraftBinding} class defines common constants, which are + * The {@link MinecraftBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Mattias Markehed - Initial contribution diff --git a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/PlayerConfig.java b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/PlayerConfig.java index 708c465646114..41c296a216212 100644 --- a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/PlayerConfig.java +++ b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/PlayerConfig.java @@ -32,7 +32,7 @@ public String getName() { /** * Set the player name. * - * @param player name + * @param name player name */ public void setName(String name) { this.playerName = name; diff --git a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/ServerConfig.java b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/ServerConfig.java index 3e571de4942d3..1c613fa68910a 100644 --- a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/ServerConfig.java +++ b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/ServerConfig.java @@ -51,7 +51,7 @@ public String getHostname() { /** * Set the host used to connect to server. * - * @param port host port + * @param hostname host port */ public void setHostname(String hostname) { this.hostname = hostname; diff --git a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/SignConfig.java b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/SignConfig.java index 9ca40e83155ec..e9efe5733908b 100644 --- a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/SignConfig.java +++ b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/config/SignConfig.java @@ -32,7 +32,7 @@ public String getName() { /** * Set the sign text to listen for. * - * @param sign text. + * @param name sign text. */ public void setName(String name) { this.signName = name; diff --git a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/discovery/MinecraftMDNSDiscoveryParticipant.java b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/discovery/MinecraftMDNSDiscoveryParticipant.java index f85a4d46bb900..162156b045986 100644 --- a/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/discovery/MinecraftMDNSDiscoveryParticipant.java +++ b/bundles/org.openhab.binding.minecraft/src/main/java/org/openhab/binding/minecraft/internal/discovery/MinecraftMDNSDiscoveryParticipant.java @@ -28,7 +28,7 @@ /** * The {@link MinecraftMDNSDiscoveryParticipant} is responsible for discovering Minecraft servers - * {@link MDNSDiscoveryService}. + * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}. * * @author Mattias Markehed - Initial contribution */ diff --git a/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/modbus/Parser.java b/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/modbus/Parser.java index 50b246c346ea2..08219becd4f93 100644 --- a/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/modbus/Parser.java +++ b/bundles/org.openhab.binding.modbus.e3dc/src/main/java/org/openhab/binding/modbus/e3dc/internal/modbus/Parser.java @@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link InfoBlockCallback} class receives callbacks from modbus poller + * The {@link Parser} class receives callbacks from modbus poller * * @author Bernd Weymann - Initial contribution */ diff --git a/bundles/org.openhab.binding.modbus.helioseasycontrols/src/main/java/org/openhab/binding/modbus/helioseasycontrols/internal/HeliosEasyControlsHandler.java b/bundles/org.openhab.binding.modbus.helioseasycontrols/src/main/java/org/openhab/binding/modbus/helioseasycontrols/internal/HeliosEasyControlsHandler.java index d0a8f366b60f9..e0db7bcb37a0d 100644 --- a/bundles/org.openhab.binding.modbus.helioseasycontrols/src/main/java/org/openhab/binding/modbus/helioseasycontrols/internal/HeliosEasyControlsHandler.java +++ b/bundles/org.openhab.binding.modbus.helioseasycontrols/src/main/java/org/openhab/binding/modbus/helioseasycontrols/internal/HeliosEasyControlsHandler.java @@ -423,7 +423,6 @@ private boolean isProperty(String variableName) { * * @param variableName The variable name * @param value The new value - * @return The value if the transaction succeeded, null otherwise * @throws HeliosException Thrown if the variable is read-only or the provided value is out of range */ public void writeValue(String variableName, String value) throws HeliosException, InterruptedException { @@ -475,7 +474,6 @@ HeliosEasyControlsBindingConstants.START_ADDRESS, preparePayload(payload), true, * Read a variable from the Helios device * * @param variableName The variable name - * @return The value */ public void readValue(String variableName) { Map variableMap = this.variableMap; diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronBindingConstants.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronBindingConstants.java index bdcf9c3f79153..52a696493ab26 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronBindingConstants.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronBindingConstants.java @@ -17,7 +17,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link Modbus.StiebelEltronBindingConstants} class defines common + * The {@link StiebelEltronBindingConstants} class defines common * constants, which are used across the whole binding. * * @author Paul Frank - Initial contribution diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronConfiguration.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronConfiguration.java index 17e088aff775e..4a93e1c4012d6 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronConfiguration.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link Modbus.StiebelEltronConfiguration} class contains fields mapping + * The {@link StiebelEltronConfiguration} class contains fields mapping * thing configuration parameters. * * @author Paul Frank - Initial contribution diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronHandlerFactory.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronHandlerFactory.java index 69d83ee84ec8e..29c777ff191ad 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronHandlerFactory.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/StiebelEltronHandlerFactory.java @@ -27,7 +27,7 @@ import org.osgi.service.component.annotations.Component; /** - * The {@link Modbus.StiebelEltronHandlerFactory} is responsible for creating things and thing + * The {@link StiebelEltronHandlerFactory} is responsible for creating things and thing * handlers. * * @author Paul Frank - Initial contribution diff --git a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/handler/StiebelEltronHandler.java b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/handler/StiebelEltronHandler.java index 20f2804478080..9b79ade7be036 100644 --- a/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/handler/StiebelEltronHandler.java +++ b/bundles/org.openhab.binding.modbus.stiebeleltron/src/main/java/org/openhab/binding/modbus/stiebeleltron/internal/handler/StiebelEltronHandler.java @@ -59,7 +59,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link Modbus.StiebelEltronHandler} is responsible for handling commands, + * The {@link StiebelEltronHandler} is responsible for handling commands, * which are sent to one of the channels and for polling the modbus. * * @author Paul Frank - Initial contribution @@ -177,7 +177,6 @@ public synchronized void poll() { * Instances of this handler should get a reference to the modbus manager * * @param thing the thing to handle - * @param modbusManager the modbus manager */ public StiebelEltronHandler(Thing thing) { super(thing); diff --git a/bundles/org.openhab.binding.modbus.studer/src/main/java/org/openhab/binding/modbus/studer/internal/StuderHandler.java b/bundles/org.openhab.binding.modbus.studer/src/main/java/org/openhab/binding/modbus/studer/internal/StuderHandler.java index d6a9aeb9cc9a9..b7b47587f0489 100644 --- a/bundles/org.openhab.binding.modbus.studer/src/main/java/org/openhab/binding/modbus/studer/internal/StuderHandler.java +++ b/bundles/org.openhab.binding.modbus.studer/src/main/java/org/openhab/binding/modbus/studer/internal/StuderHandler.java @@ -95,9 +95,6 @@ public class StuderHandler extends BaseThingHandler { * Instances of this handler * * @param thing the thing to handle - * @param type the type of thing to handle - * @param slaveAddress the address of thing - * @param refreshSec the address of thing */ public StuderHandler(Thing thing) { super(thing); @@ -299,7 +296,7 @@ private synchronized void registerPollTask(int registerNumber) { * The register array is first parsed, then each of the channels are updated * to the new values * - * @param n register readed + * @param registerNumber register readed * @param registers byte array read from the modbus slave */ protected void handlePolledData(int registerNumber, ModbusRegisterArray registers) { diff --git a/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/discovery/SunspecDiscoveryProcess.java b/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/discovery/SunspecDiscoveryProcess.java index 8f6500ebf7efc..c043ac70e6158 100644 --- a/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/discovery/SunspecDiscoveryProcess.java +++ b/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/discovery/SunspecDiscoveryProcess.java @@ -142,7 +142,6 @@ public SunspecDiscoveryProcess(ModbusEndpointThingHandler handler, ModbusDiscove /** * Start model detection * - * @param uid the thing type to look for * @throws EndpointNotInitializedException */ public void detectModel() { diff --git a/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/handler/AbstractSunSpecHandler.java b/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/handler/AbstractSunSpecHandler.java index 3a23c0df28243..8138b564da0d9 100644 --- a/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/handler/AbstractSunSpecHandler.java +++ b/bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/handler/AbstractSunSpecHandler.java @@ -94,7 +94,6 @@ public abstract class AbstractSunSpecHandler extends BaseThingHandler { * Instances of this handler should get a reference to the modbus manager * * @param thing the thing to handle - * @param managerRef the modbus manager */ public AbstractSunSpecHandler(Thing thing) { super(thing); diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java index b7fa3e21cf4e1..4886cd09fad35 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/ModbusBindingConstants.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link ModbusBinding} class defines some constants + * The {@link ModbusBindingConstants} class defines some constants * public that might be used from other bundles as well. * * @author Sami Salonen - Initial contribution diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusDiscoveryService.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusDiscoveryService.java index bf13aa727ecca..1ad02f763ed7d 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusDiscoveryService.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/discovery/internal/ModbusDiscoveryService.java @@ -135,7 +135,7 @@ public Set getSupportedThingTypes() { * Running bridges have a ModbusThingHandlerDiscoveryService connected * which will be responsible for the discovery * - * @param handler the Modbus bridge handler + * @param service discovery service */ @Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC) protected void addModbusEndpoint(ModbusThingHandlerDiscoveryService service) { @@ -146,7 +146,7 @@ protected void addModbusEndpoint(ModbusThingHandlerDiscoveryService service) { /** * Remove an already registered thing handler discovery component * - * @param handler the handler that has been removed + * @param service discovery service */ protected void removeModbusEndpoint(ModbusThingHandlerDiscoveryService service) { logger.trace("Removed handler: {}", service); diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/handler/BaseModbusThingHandler.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/handler/BaseModbusThingHandler.java index 6ae9652b06122..af4fd2c8123ed 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/handler/BaseModbusThingHandler.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/handler/BaseModbusThingHandler.java @@ -98,8 +98,8 @@ public boolean isDiscoveryEnabled() { * @param request request to send * @param pollPeriodMillis poll interval, in milliseconds * @param initialDelayMillis initial delay before starting polling, in milliseconds - * @param callback callback to call with data - * @param callback callback to call in case of failure + * @param resultCallback callback to call with data + * @param failureCallback callback to call in case of failure * @return poll task representing the regular poll * @throws IllegalStateException when this communication has been closed already */ @@ -133,8 +133,8 @@ public boolean unregisterRegularPoll(PollTask task) { * background. * * @param request request to send - * @param callback callback to call with data - * @param callback callback to call in case of failure + * @param resultCallback callback to call with data + * @param failureCallback callback to call in case of failure * @return future representing the polled task * @throws IllegalStateException when this communication has been closed already */ @@ -152,8 +152,8 @@ public Future submitOneTimePoll(ModbusReadRequestBlueprint request, ModbusRea * background. * * @param request request to send - * @param callback callback to call with response - * @param callback callback to call in case of failure + * @param resultCallback callback to call with response + * @param failureCallback callback to call in case of failure * @return future representing the task * @throws IllegalStateException when this communication has been closed already */ diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusBindingConstantsInternal.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusBindingConstantsInternal.java index 743e64f08d6bc..e1ad58fca3de9 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusBindingConstantsInternal.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ModbusBindingConstantsInternal.java @@ -22,7 +22,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link ModbusBinding} class defines common constants, which are + * The {@link ModbusBindingConstantsInternal} class defines common constants, which are * used across the whole binding. * * @author Sami Salonen - Initial contribution diff --git a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ValueTransformation.java b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ValueTransformation.java index 6043646b50418..69d39e8dae11a 100644 --- a/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ValueTransformation.java +++ b/bundles/org.openhab.binding.modbus/src/main/java/org/openhab/binding/modbus/internal/ValueTransformation.java @@ -38,7 +38,7 @@ public interface ValueTransformation { * * @param context * @param types types to used to parse the transformation result - * @param command + * @param state * @return Transformed command, or null if no transformation was possible */ default @Nullable State transformState(BundleContext context, List> types, State state) { diff --git a/bundles/org.openhab.binding.monopriceaudio/src/main/java/org/openhab/binding/monopriceaudio/internal/communication/MonopriceAudioConnector.java b/bundles/org.openhab.binding.monopriceaudio/src/main/java/org/openhab/binding/monopriceaudio/internal/communication/MonopriceAudioConnector.java index 4eb6552711d32..771d05f51207e 100644 --- a/bundles/org.openhab.binding.monopriceaudio/src/main/java/org/openhab/binding/monopriceaudio/internal/communication/MonopriceAudioConnector.java +++ b/bundles/org.openhab.binding.monopriceaudio/src/main/java/org/openhab/binding/monopriceaudio/internal/communication/MonopriceAudioConnector.java @@ -183,7 +183,7 @@ public void sendPing() throws MonopriceAudioException { /** * Get the status of a zone * - * @param zone the zone to query for current status + * @param zoneId the zone to query for current status * * @throws MonopriceAudioException - In case of any problem */ @@ -195,7 +195,7 @@ public void queryZone(String zoneId) throws MonopriceAudioException { * Monoprice 31028 and OSD Audio PAM1270 amps do not report treble, bass and balance with the main status inquiry, * so we must send three extra commands to retrieve those values * - * @param zone the zone to query for current treble, bass and balance status + * @param zoneId the zone to query for current treble, bass and balance status * * @throws MonopriceAudioException - In case of any problem */ diff --git a/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/action/MPDActions.java b/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/action/MPDActions.java index 14c74131c8ce4..7d9581d7a90f6 100644 --- a/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/action/MPDActions.java +++ b/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/action/MPDActions.java @@ -24,7 +24,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link @MPDActions} defines rule actions for the Music Player Daemon binding. + * The {@link MPDActions} defines rule actions for the Music Player Daemon binding. * * @author Stefan Röllin - Initial contribution */ diff --git a/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/protocol/MPDConnection.java b/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/protocol/MPDConnection.java index 1043d9a73c488..61e7aa9da60fa 100644 --- a/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/protocol/MPDConnection.java +++ b/bundles/org.openhab.binding.mpd/src/main/java/org/openhab/binding/mpd/internal/protocol/MPDConnection.java @@ -39,9 +39,7 @@ public class MPDConnection implements MPDResponseListener { /** * Constructor * - * @param address the IP address of the music player daemon - * @param port the TCP port to be used - * @param password the password to connect to the music player daemon + * @param listener */ public MPDConnection(MPDEventListener listener) { this.listener = listener; diff --git a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/ChannelStateUpdateListener.java b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/ChannelStateUpdateListener.java index 0b67ec5759ddc..528dc49cb3588 100644 --- a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/ChannelStateUpdateListener.java +++ b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/ChannelStateUpdateListener.java @@ -44,7 +44,7 @@ public interface ChannelStateUpdateListener { * The channel is of kind Trigger. * * @param channelUID The channel uid - * @param value The new value. Doesn't necessarily need to be different than the value before. + * @param eventPayload The new value. Doesn't necessarily need to be different than the value before. */ void triggerChannel(ChannelUID channelUID, String eventPayload); } 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 cfb27ab9f6e18..b19641893193f 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 @@ -41,7 +41,7 @@ * To automatically subscribe to all fields, a call to * {@link #subscribeAndReceive(MqttBrokerConnection, ScheduledExecutorService, String, AttributeChanged, int)} is * required. - * Unsubscribe with a call to {@link #unsubscribe(AbstractMqttAttributeClass)}. + * Unsubscribe with a call to {@link #unsubscribe()}. *

    * *

    @@ -134,8 +134,6 @@ protected AbstractMqttAttributeClass() { /** * Unsubscribe from all topics of the managed object. * - * @param connection A broker connection to remove the subscriptions from. - * @param objectWithFields A bean class * @return Returns a future that completes as soon as all unsubscriptions have been performed. */ public CompletableFuture<@Nullable Void> unsubscribe() { diff --git a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/tools/ChildMap.java b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/tools/ChildMap.java index a5593eecace40..51cffdca38db0 100644 --- a/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/tools/ChildMap.java +++ b/bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/tools/ChildMap.java @@ -67,7 +67,6 @@ public Stream stream() { /** * Modifies the map in way that it matches the entries of the given childIDs. * - * @param future A future that completes as soon as all children have their added-action performed. * @param childIDs The list of IDs that should be in the map. Everything else currently in the map will be removed. * @param addedAction A function where the newly added child is given as an argument to perform any actions on it. * A future is expected as a return value that completes as soon as said action is performed. @@ -75,7 +74,7 @@ public Stream stream() { * expected as a * result. * @param removedCallback A callback, that is called whenever a child got removed by the - * {@link #apply(CompletableFuture, String[], Function)} method. + * {@link #apply(String[], Function, Function, Consumer)} method. * @return Complete successfully if all "addedAction" complete successfully, otherwise complete exceptionally. */ public CompletableFuture<@Nullable Void> apply(String[] childIDs, diff --git a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/HaID.java b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/HaID.java index 436a99e7f25ac..4a10586f9763b 100644 --- a/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/HaID.java +++ b/bundles/org.openhab.binding.mqtt.homeassistant/src/main/java/org/openhab/binding/mqtt/homeassistant/internal/HaID.java @@ -167,7 +167,7 @@ public static Collection fromConfig(HandlerConfiguration config) { * Return the topic to put into the HandlerConfiguration for this component. *

    * objectid in the thing configuration will be - * nodeID/objectID from the HaID, if nodeID is not empty. + * nodeID/objectID from the HaID, if nodeID is not empty. *

    * * @return the short topic. diff --git a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Device.java b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Device.java index 2ed5a12461762..ffea8f4f4dc29 100644 --- a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Device.java +++ b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Device.java @@ -36,8 +36,10 @@ /** * Homie 3.x Device. This is also the base class to subscribe to and parse a homie MQTT topic tree. - * First use {@link #subscribe(AbstractMqttAttributeClass)} to subscribe to the device/nodes/properties tree. - * If everything has been received and parsed, call {@link #startChannels(MqttBrokerConnection, HomieThingHandler)} + * First use {@link #subscribe(MqttBrokerConnection, ScheduledExecutorService, int)} + * to subscribe to the device/nodes/properties tree. + * If everything has been received and parsed, call + * {@link #startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)} * to also subscribe to the property values. Usage: * *

    @@ -100,7 +102,7 @@ public Device(ThingUID thingUID, DeviceCallback callback, DeviceAttributes attri
          * and subscribe to all node attributes. Parse node properties. This will not subscribe
          * to properties though. If subscribing to all necessary topics worked {@link #isInitialized()} will return true.
          *
    -     * Call {@link #startChannels(MqttBrokerConnection)} subsequently.
    +     * Call {@link #startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)} subsequently.
          *
          * @param connection A broker connection
          * @param scheduler A scheduler to realize the timeout
    @@ -258,7 +260,7 @@ public Node createNode(String nodeID, NodeAttributes attributes) {
         /**
          * 

    * The nodes of a device are determined by the device attribute "$nodes". If that attribute changes, - * {@link #attributeChanged(CompletableFuture, String, Object, MqttBrokerConnection, ScheduledExecutorService)} is + * {@link #attributeChanged(String, Object, MqttBrokerConnection, ScheduledExecutorService, boolean)} is * called. The {@link #nodes} map will be synchronized and this method will be called for every removed node. *

    * diff --git a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/DeviceCallback.java b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/DeviceCallback.java index 8a2ee8a6ab4b5..ff27bb182677f 100644 --- a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/DeviceCallback.java +++ b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/DeviceCallback.java @@ -41,7 +41,7 @@ public interface DeviceCallback extends ChannelStateUpdateListener { /** * Called, whenever a Homie property was existing before, but is not anymore. * - * @param node The affected property class. + * @param property The affected property class. */ void propertyRemoved(Property property); @@ -55,7 +55,7 @@ public interface DeviceCallback extends ChannelStateUpdateListener { /** * Called, whenever a Homie property was added or changed. * - * @param node The affected property class. + * @param property The affected property class. */ void propertyAddedOrChanged(Property property); } diff --git a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Node.java b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Node.java index b84ce0b7ae909..84d4582e429c0 100644 --- a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Node.java +++ b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Node.java @@ -79,8 +79,8 @@ public Node(String topic, String nodeID, ThingUID thingUID, DeviceCallback callb /** * Parse node properties. This will not subscribe to properties though. Call - * {@link Device#startChannels(MqttBrokerConnection)} as soon as the returned future has - * completed. + * {@link Device#startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)} + * as soon as the returned future has completed. */ public CompletableFuture<@Nullable Void> subscribe(MqttBrokerConnection connection, ScheduledExecutorService scheduler, int timeout) { @@ -106,7 +106,6 @@ public void nodeRestoredFromConfig() { /** * Unsubscribe from node attribute and also all property attributes and the property value * - * @param connection A broker connection * @return Returns a future that completes as soon as all unsubscriptions have been performed. */ public CompletableFuture<@Nullable Void> stop() { @@ -156,7 +155,7 @@ public Property createProperty(String propertyID, PropertyAttributes attributes) /** *

    * The properties of a node are determined by the node attribute "$properties". If that attribute changes, - * {@link #attributeChanged(CompletableFuture, String, Object, MqttBrokerConnection, ScheduledExecutorService)} is + * {@link #attributeChanged(String, Object, MqttBrokerConnection, ScheduledExecutorServic, boolean)} is * called. The {@link #properties} map will be synchronized and this method will be called for every removed * property. *

    diff --git a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java index 5a3d16d7b46c1..aa4e5ecbaece3 100644 --- a/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java +++ b/bundles/org.openhab.binding.mqtt.homie/src/main/java/org/openhab/binding/mqtt/homie/internal/homie300/Property.java @@ -26,7 +26,6 @@ import org.eclipse.jdt.annotation.Nullable; import org.openhab.binding.mqtt.generic.ChannelConfigBuilder; import org.openhab.binding.mqtt.generic.ChannelState; -import org.openhab.binding.mqtt.generic.mapping.AbstractMqttAttributeClass; import org.openhab.binding.mqtt.generic.mapping.AbstractMqttAttributeClass.AttributeChanged; import org.openhab.binding.mqtt.generic.mapping.ColorMode; import org.openhab.binding.mqtt.generic.values.ColorValue; @@ -97,7 +96,9 @@ public Property(String topic, Node node, String propertyID, DeviceCallback callb /** * Subscribe to property attributes. This will not subscribe - * to the property value though. Call {@link Device#startChannels(MqttBrokerConnection)} to do that. + * to the property value though. Call + * {@link Device#startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)} + * to do that. * * @return Returns a future that completes as soon as all attribute values have been received or requests have timed * out. @@ -267,7 +268,7 @@ public void createChannelFromAttribute() { /** * @return Returns the channelState. You should have called - * {@link Property#subscribe(AbstractMqttAttributeClass, int)} + * {@link Property#subscribe(MqttBrokerConnection, ScheduledExecutorService, int)} * and waited for the future to complete before calling this Getter. */ public @Nullable ChannelState getChannelState() { @@ -280,7 +281,6 @@ public void createChannelFromAttribute() { * @param connection A broker connection * @param scheduler A scheduler to realize the timeout * @param timeout A timeout in milliseconds. Can be 0 to disable the timeout and let the future return earlier. - * @param channelStateUpdateListener An update listener * @return A future that completes with true if the subscribing worked and false and/or exceptionally otherwise. */ public CompletableFuture<@Nullable Void> startChannel(MqttBrokerConnection connection, diff --git a/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/handler/BrokerHandler.java b/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/handler/BrokerHandler.java index 1dbcb23b151c1..7734b34f3ad46 100644 --- a/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/handler/BrokerHandler.java +++ b/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/handler/BrokerHandler.java @@ -73,7 +73,7 @@ public void connectionStateChanged(MqttConnectionState state, @Nullable Throwabl } /** - * This method gets called by the {@link PinningSSLContextProvider} if a new public key + * This method gets called by the {@link PinTrustManager} if a new public key * or certificate hash got pinned. The hash is stored in the thing configuration. */ @Override @@ -105,7 +105,7 @@ public void pinnedLearnedHash(Pin pin) { @Override public void pinnedConnectionDenied(Pin pin) { - // We don't need to handle this here, because the {@link PinningSSLContextProvider} + // We don't need to handle this here, because the {@link PinTrustManager} // will throw a CertificateException if the connection fails. } @@ -136,12 +136,12 @@ public boolean discoveryEnabled() { /** * Reads the thing configuration related to public key or certificate pinning, creates an appropriate a - * {@link PinningSSLContextProvider} and assigns it to the {@link MqttBrokerConnection} instance. + * {@link PinTrustManager} and assigns it to the {@link MqttBrokerConnection} instance. * The instance need to be set before calling this method. If the SHA-256 algorithm is not supported * by the platform, this method will do nothing. * * @throws IllegalArgumentException Throws this exception, if provided hash values cannot be - * assigned to the {@link PinningSSLContextProvider}. + * assigned to the {@link PinTrustManager}. */ protected void assignSSLContextProvider(BrokerHandlerConfig config, MqttBrokerConnection connection, PinnedCallback callback) throws IllegalArgumentException { diff --git a/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/internal/MqttThingID.java b/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/internal/MqttThingID.java index 3613ba6f5564d..dac1d983dca70 100644 --- a/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/internal/MqttThingID.java +++ b/bundles/org.openhab.binding.mqtt/src/main/java/org/openhab/binding/mqtt/internal/MqttThingID.java @@ -34,7 +34,8 @@ public static String getThingID(String host, int port) { /** * Creates a normal broker thing with an url that will be converted to a thing ID. * - * @param url The broker connection url + * @param host The broker connection (host name) + * @param port The port * @return Returns a ThingUID */ public static ThingUID getThingUID(String host, int port) { diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/discovery/VehicleDiscovery.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/discovery/VehicleDiscovery.java index 9612ec20da0d7..66a16830606e5 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/discovery/VehicleDiscovery.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/discovery/VehicleDiscovery.java @@ -202,7 +202,7 @@ public static String getServices(Vehicle vehicle, String suffix, boolean enabled * Get all field names from a DTO with a specific value * Used to get e.g. all services which are "ACTIVATED" * - * @param DTO Object + * @param dto Object * @param compare String which needs to map with the value * @return String with all field names matching this value separated with Spaces */ diff --git a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/VehicleStatusUtils.java b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/VehicleStatusUtils.java index 05b82e7f615fd..8b7cc0a08f8fb 100644 --- a/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/VehicleStatusUtils.java +++ b/bundles/org.openhab.binding.mybmw/src/main/java/org/openhab/binding/mybmw/internal/utils/VehicleStatusUtils.java @@ -147,7 +147,7 @@ public static VehicleType vehicleType(String driveTrain, String model) { * 3) take a guess from fuel indicators * * @param unitJson - * @param indicators + * @param vehicle * @return */ public static int getRange(String unitJson, Vehicle vehicle) { @@ -165,7 +165,7 @@ public static int getRange(String unitJson, Vehicle vehicle) { * -- smaller one is assigned to fuel range * -- bigger one is assigned to hybrid range * - * @see VehicleStatusTest testGuessRange + * @see org.openhab.binding.mybmw.internal.dto.VehicleStatusTest testGuessRange * * @param unitJson * @param vehicle diff --git a/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/NeatoBindingConstants.java b/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/NeatoBindingConstants.java index 133ec1b5baf94..4f00f5f988ad2 100644 --- a/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/NeatoBindingConstants.java +++ b/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/NeatoBindingConstants.java @@ -15,7 +15,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link NeatoBinding} class defines common constants, which are + * The {@link NeatoBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Patrik Wimnell - Initial contribution diff --git a/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/classes/BeehiveAuthentication.java b/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/classes/BeehiveAuthentication.java index 5d0da64891457..14447c38bbfef 100644 --- a/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/classes/BeehiveAuthentication.java +++ b/bundles/org.openhab.binding.neato/src/main/java/org/openhab/binding/neato/internal/classes/BeehiveAuthentication.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link BeehiveAuthenticcation} is the internal class for handling authentication. + * The {@link BeehiveAuthentication} is the internal class for handling authentication. * * @author Patrik Wimnell - Initial contribution */ diff --git a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/NeeoHandlerCallback.java b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/NeeoHandlerCallback.java index da25be95a20b5..f6c9ce6d1c705 100644 --- a/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/NeeoHandlerCallback.java +++ b/bundles/org.openhab.binding.neeo/src/main/java/org/openhab/binding/neeo/internal/NeeoHandlerCallback.java @@ -43,7 +43,7 @@ public interface NeeoHandlerCallback { * Callback to the bridge/thing to update the state of a channel in the bridge/thing. * * @param channelId the non-null, non-empty channel id - * @param state the new non-null {@State} + * @param state the new non-null {@link State} */ void stateChanged(String channelId, State state); diff --git a/bundles/org.openhab.binding.neohub/src/main/java/org/openhab/binding/neohub/internal/NeoHubGetEngineersData.java b/bundles/org.openhab.binding.neohub/src/main/java/org/openhab/binding/neohub/internal/NeoHubGetEngineersData.java index 10fee8ddd22de..0254b257653db 100644 --- a/bundles/org.openhab.binding.neohub/src/main/java/org/openhab/binding/neohub/internal/NeoHubGetEngineersData.java +++ b/bundles/org.openhab.binding.neohub/src/main/java/org/openhab/binding/neohub/internal/NeoHubGetEngineersData.java @@ -56,7 +56,6 @@ public int getDeviceType() { * Create wrapper around a JSON string * * @param fromJson the JSON string - * @return a NeoHubGetEngData wrapper around the JSON string * @throws JsonSyntaxException * */ diff --git a/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/EnergyApi.java b/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/EnergyApi.java index 23d580678839e..2171e621fa473 100644 --- a/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/EnergyApi.java +++ b/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/EnergyApi.java @@ -60,7 +60,7 @@ public void switchSchedule(String homeId, String scheduleId) throws NetatmoExcep * * @param homeId The id of home (required) * @param mode The mode. (required) - * @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize + * @throws NetatmoException when call failed, e.g. server error or cannot deserialize */ public void setThermMode(String homeId, String mode) throws NetatmoException { UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_SET_THERM_MODE, PARAM_HOME_ID, homeId, PARAM_MODE, mode); @@ -76,7 +76,7 @@ public void setThermMode(String homeId, String mode) throws NetatmoException { * @param mode The mode. (required) * @param endtime For manual or max setpoint_mode, defines when the setpoint expires. * @param temp For manual setpoint_mode, defines the temperature setpoint (in °C) - * @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize + * @throws NetatmoException when call failed, e.g. server error or cannot deserialize */ public void setThermpoint(String homeId, String roomId, SetpointMode mode, long endtime, double temp) throws NetatmoException { diff --git a/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/utils/WeatherUtils.java b/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/utils/WeatherUtils.java index 9d3eae10c6989..2c5239c555f96 100644 --- a/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/utils/WeatherUtils.java +++ b/bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/utils/WeatherUtils.java @@ -86,7 +86,7 @@ public static double humidex(double temperature, double hygro) { * Compute the associated scale appreciation of a given humidex index * https://www.researchgate.net/figure/The-scale-of-Humidex-and-the-degree-of-comfort_tbl1_335293174 * - * @param Humidex index value + * @param humidex index value * @return scale between 0 and 4 */ public static int humidexScale(double humidex) { 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 4f4e24c26dbe5..2f038e70daa91 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 @@ -67,7 +67,7 @@ public ExpiringCacheAsync(long expiry, @Nullable ExpiringCacheUpdate cacheUpdate /** * Returns the value - possibly from the cache, if it is still valid. * - * @return the value + * @param callback callback to return the value */ public void getValue(Consumer callback) { if (isExpired()) { diff --git a/bundles/org.openhab.binding.nibeheatpump/src/main/java/org/openhab/binding/nibeheatpump/internal/config/NibeHeatPumpConfiguration.java b/bundles/org.openhab.binding.nibeheatpump/src/main/java/org/openhab/binding/nibeheatpump/internal/config/NibeHeatPumpConfiguration.java index 3d59d0e2c6adb..82a5b178844d9 100644 --- a/bundles/org.openhab.binding.nibeheatpump/src/main/java/org/openhab/binding/nibeheatpump/internal/config/NibeHeatPumpConfiguration.java +++ b/bundles/org.openhab.binding.nibeheatpump/src/main/java/org/openhab/binding/nibeheatpump/internal/config/NibeHeatPumpConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.nibeheatpump.internal.config; /** - * Configuration class for {@link NibeHeatPumpBinding} device. + * Configuration class for NibeHeatPump device. * * * @author Pauli Anttila - Initial contribution diff --git a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/command/GenericStatusUpdate.java b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/command/GenericStatusUpdate.java index f9cbfbd16f64b..eb7f6a22a69e6 100644 --- a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/command/GenericStatusUpdate.java +++ b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/command/GenericStatusUpdate.java @@ -32,7 +32,7 @@ import org.openhab.core.thing.Channel; /** - * generic command that retrieves status values for all channels defined in {@link VVM320Channels} + * generic command that retrieves status values for all channels defined in VVM320Channels * * @author Alexander Friese - initial contribution */ diff --git a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/connector/UplinkWebInterface.java b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/connector/UplinkWebInterface.java index df310974e067a..f54573db450ea 100644 --- a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/connector/UplinkWebInterface.java +++ b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/connector/UplinkWebInterface.java @@ -208,8 +208,6 @@ private void processAuthenticationResult(CommunicationStatus status) { /** * Constructor to set up interface - * - * @param config the Bridge configuration */ public UplinkWebInterface(ScheduledExecutorService scheduler, NibeUplinkHandler handler, HttpClient httpClient) { this.uplinkHandler = handler; diff --git a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/handler/NibeUplinkHandler.java b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/handler/NibeUplinkHandler.java index 75c83f68ca0ab..89953c8bd47e3 100644 --- a/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/handler/NibeUplinkHandler.java +++ b/bundles/org.openhab.binding.nibeuplink/src/main/java/org/openhab/binding/nibeuplink/internal/handler/NibeUplinkHandler.java @@ -32,8 +32,9 @@ @NonNullByDefault public interface NibeUplinkHandler extends ThingHandler, ChannelProvider { /** - * Called from {@link NibeUplinkWebInterface#authenticate()} to update - * the thing status because updateStatus is protected. + * Called from + * {@link org.openhab.binding.nibeuplink.internal.connector.UplinkWebInterface.WebRequestExecutor#authenticate()} + * to update the thing status because updateStatus is protected. * * @param status Bridge status * @param statusDetail Bridge status detail diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcAction.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcAction.java index 8b90263e71228..6de5f6e83f362 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcAction.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcAction.java @@ -55,7 +55,7 @@ protected NhcAction(String id, String name, ActionType type, @Nullable String lo } /** - * This method should be called when an object implementing the {@NhcActionEvent} interface is initialized. + * This method should be called when an object implementing the {@link NhcActionEvent} interface is initialized. * It keeps a record of the event handler in that object so it can be updated when the action receives an update * from the Niko Home Control IP-interface. * @@ -66,7 +66,7 @@ public void setEventHandler(NhcActionEvent eventHandler) { } /** - * This method should be called when an object implementing the {@NhcActionEvent} interface is disposed. + * This method should be called when an object implementing the {@link NhcActionEvent} interface is disposed. * It resets the reference, so no updates go to the handler anymore. * */ diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcControllerEvent.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcControllerEvent.java index 53aa8d4213e51..b4815e21b0993 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcControllerEvent.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcControllerEvent.java @@ -95,7 +95,7 @@ default String getToken() { /** * This method is called when a notice event is received from the Niko Home Control controller. * - * @param alarmText + * @param noticeText */ void noticeEvent(String noticeText); diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcEnergyMeter.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcEnergyMeter.java index 83929106c7743..735e338e162f6 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcEnergyMeter.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NhcEnergyMeter.java @@ -74,7 +74,8 @@ public void energyMeterRemoved() { } /** - * This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is initialized. + * This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is + * initialized. * It keeps a record of the event handler in that object so it can be updated when the action receives an update * from the Niko Home Control IP-interface. * @@ -85,7 +86,7 @@ public void setEventHandler(NhcEnergyMeterEvent eventHandler) { } /** - * This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is disposed. + * This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is disposed. * It resets the reference, so no updates go to the handler anymore. * */ 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 e55bacf19de08..9312d8fd4dd6c 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 @@ -109,7 +109,7 @@ private void updateChannels() { } /** - * This method should be called when an object implementing the {@NhcThermostatEvent} interface is initialized. + * This method should be called when an object implementing the {@link NhcThermostatEvent} interface is initialized. * It keeps a record of the event handler in that object so it can be updated when the action receives an update * from the Niko Home Control IP-interface. * @@ -120,7 +120,7 @@ public void setEventHandler(NhcThermostatEvent eventHandler) { } /** - * This method should be called when an object implementing the {@NhcThermostatEvent} interface is disposed. + * This method should be called when an object implementing the {@link NhcThermostatEvent} interface is disposed. * It resets the reference, so no updates go to the handler anymore. * */ @@ -311,7 +311,7 @@ public void executeMode(String mode) { * {@link NhcThermostat2}. * * @param overrule temperature to overrule the setpoint in 0.1°C multiples - * @param time time duration in min for overrule + * @param overruletime time duration in min for overrule */ public abstract void executeOverrule(int overrule, int overruletime); diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NikoHomeControlCommunication.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NikoHomeControlCommunication.java index c607ec1d9b757..4d0b20bfcf62e 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NikoHomeControlCommunication.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/NikoHomeControlCommunication.java @@ -150,7 +150,7 @@ public ZoneId getTimeZone() { /** * Return all actions in the Niko Home Control Controller. * - * @return Map<String, {@link NhcAction}> + * @return Map<String, {@link NhcAction}> */ public Map getActions() { return actions; @@ -159,7 +159,7 @@ public Map getActions() { /** * Return all thermostats in the Niko Home Control Controller. * - * @return Map<String, {@link NhcThermostat}> + * @return Map<String, {@link NhcThermostat}> */ public Map getThermostats() { return thermostats; @@ -168,7 +168,7 @@ public Map getThermostats() { /** * Return all energyMeters meters in the Niko Home Control Controller. * - * @return Map<String, {@link NhcEnergyMeter}> + * @return Map<String, {@link NhcEnergyMeter}> */ public Map getEnergyMeters() { return energyMeters; diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc1/NhcThermostat1.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc1/NhcThermostat1.java index 41c52a2c88397..8f78a0d4b43d0 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc1/NhcThermostat1.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc1/NhcThermostat1.java @@ -51,7 +51,7 @@ public void executeMode(int mode) { * Sends thermostat setpoint to Niko Home Control. * * @param overrule temperature to overrule the setpoint in 0.1°C multiples - * @param time time duration in min for overrule + * @param overruletime time duration in min for overrule */ @Override public void executeOverrule(int overrule, int overruletime) { diff --git a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc2/NikoHomeControlCommunication2.java b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc2/NikoHomeControlCommunication2.java index 60734b5e50c18..e7d7f26a4adf1 100644 --- a/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc2/NikoHomeControlCommunication2.java +++ b/bundles/org.openhab.binding.nikohomecontrol/src/main/java/org/openhab/binding/nikohomecontrol/internal/protocol/nhc2/NikoHomeControlCommunication2.java @@ -92,7 +92,7 @@ public class NikoHomeControlCommunication2 extends NikoHomeControlCommunication * Niko Home Control II Connected Controller. * * @throws CertificateException when the SSL context for MQTT communication cannot be created - * @throws UnknownHostException when the IP address is not provided + * @throws java.net.UnknownHostException when the IP address is not provided * */ public NikoHomeControlCommunication2(NhcControllerEvent handler, String clientId, diff --git a/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/SDS011Communicator.java b/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/SDS011Communicator.java index 0383c165c60c9..3f9bd1e8823f3 100644 --- a/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/SDS011Communicator.java +++ b/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/SDS011Communicator.java @@ -72,7 +72,6 @@ public SDS011Communicator(SDS011Handler thingHandler, SerialPortIdentifier portI * * @param mode the {@link WorkMode} if we want to use polling or reporting * @param interval the time between polling or reportings - * @return {@code true} if we can communicate with the device * @throws PortInUseException * @throws TooManyListenersException * @throws IOException diff --git a/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/messages/SensorReply.java b/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/messages/SensorReply.java index 0fe14406c91b2..c96750b1b206a 100644 --- a/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/messages/SensorReply.java +++ b/bundles/org.openhab.binding.novafinedust/src/main/java/org/openhab/binding/novafinedust/internal/sds011protocol/messages/SensorReply.java @@ -62,7 +62,8 @@ public byte getCommandID() { } /** - * Gets the first byte from the data bytes (usually holds the {@link Command}) as a form of some sub command + * Gets the first byte from the data bytes (usually holds the + * {@link org.openhab.binding.novafinedust.internal.sds011protocol.Command}) as a form of some sub command * * @return first byte from the data section of a reply */ diff --git a/bundles/org.openhab.binding.ntp/src/main/java/org/openhab/binding/ntp/internal/NtpBindingConstants.java b/bundles/org.openhab.binding.ntp/src/main/java/org/openhab/binding/ntp/internal/NtpBindingConstants.java index a71e5fe01e5ed..f166dd096c38b 100644 --- a/bundles/org.openhab.binding.ntp/src/main/java/org/openhab/binding/ntp/internal/NtpBindingConstants.java +++ b/bundles/org.openhab.binding.ntp/src/main/java/org/openhab/binding/ntp/internal/NtpBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link ntpBinding} class defines common constants, which are used across + * The {@link NtpBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Marcel Verpaalen - Initial contribution diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/NukiHandlerFactory.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/NukiHandlerFactory.java index 6bfe90a0c052a..7a5193f75b836 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/NukiHandlerFactory.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/NukiHandlerFactory.java @@ -45,7 +45,7 @@ * handlers. * * @author Markus Katter - Initial contribution - * @contributer Jan Vybíral - Improved thing id generation + * @author Jan Vybíral - Improved thing id generation */ @Component(service = ThingHandlerFactory.class, configurationPid = "binding.nuki") @NonNullByDefault diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/constants/NukiBindingConstants.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/constants/NukiBindingConstants.java index f3acb9afc2532..1670ffab18c96 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/constants/NukiBindingConstants.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/constants/NukiBindingConstants.java @@ -20,12 +20,12 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link NukiBinding} class defines common constants, which are + * The {@link NukiBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration - * @contributer Jan Vybíral - Opener integration + * @author Christian Hoefler - Door sensor integration + * @author Jan Vybíral - Opener integration */ @NonNullByDefault public class NukiBindingConstants { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/BridgeLockStateResponse.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/BridgeLockStateResponse.java index e37ea76940110..405a91b17c3af 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/BridgeLockStateResponse.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/BridgeLockStateResponse.java @@ -18,7 +18,7 @@ * The {@link BridgeLockStateResponse} class wraps {@link BridgeApiLockStateDto} class. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration + * @author Christian Hoefler - Door sensor integration */ public class BridgeLockStateResponse extends NukiBaseResponse { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiApiServlet.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiApiServlet.java index f547d25ef8632..9a0bee0aa6473 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiApiServlet.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiApiServlet.java @@ -46,8 +46,8 @@ * The {@link NukiApiServlet} class is responsible for handling the callbacks from the Nuki Bridge. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration - * @contributer Jan Vybíral - Added Opener support, improved callback handling + * @author Christian Hoefler - Door sensor integration + * @author Jan Vybíral - Added Opener support, improved callback handling */ @NonNullByDefault public class NukiApiServlet extends HttpServlet { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiHttpClient.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiHttpClient.java index fd31e33f7cdcc..91d810dc73432 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiHttpClient.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dataexchange/NukiHttpClient.java @@ -44,7 +44,7 @@ * The {@link NukiHttpClient} class is responsible for getting data from the Nuki Bridge. * * @author Markus Katter - Initial contribution - * @contributer Jan Vybíral - Hashed token authentication + * @author Jan Vybíral - Hashed token authentication */ @NonNullByDefault public class NukiHttpClient { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateDto.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateDto.java index 5fea98c52542f..6637170cb8966 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateDto.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateDto.java @@ -17,7 +17,7 @@ * endpoint. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration + * @author Christian Hoefler - Door sensor integration */ public class BridgeApiLockStateDto extends BridgeApiDeviceStateDto { private boolean success; diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateRequestDto.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateRequestDto.java index 3051f26cf3db2..70bed6791cc1b 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateRequestDto.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/dto/BridgeApiLockStateRequestDto.java @@ -17,7 +17,7 @@ * Bridge to the openHAB Server. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration + * @author Christian Hoefler - Door sensor integration */ public class BridgeApiLockStateRequestDto extends BridgeApiDeviceStateDto { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiBridgeHandler.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiBridgeHandler.java index 3db6e5b4d0d2a..8f37824005887 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiBridgeHandler.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiBridgeHandler.java @@ -53,7 +53,7 @@ * sent to one of the channels. * * @author Markus Katter - Initial contribution - * @contributer Jan Vybíral - Improved callback handling + * @author Jan Vybíral - Improved callback handling */ @NonNullByDefault public class NukiBridgeHandler extends BaseBridgeHandler { diff --git a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiSmartLockHandler.java b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiSmartLockHandler.java index effc3338de29a..620622aa91620 100644 --- a/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiSmartLockHandler.java +++ b/bundles/org.openhab.binding.nuki/src/main/java/org/openhab/binding/nuki/internal/handler/NukiSmartLockHandler.java @@ -29,8 +29,8 @@ * sent to one of the channels. * * @author Markus Katter - Initial contribution - * @contributer Christian Hoefler - Door sensor integration - * @contributer Jan Vybíral - Refactoring, added more channels + * @author Christian Hoefler - Door sensor integration + * @author Jan Vybíral - Refactoring, added more channels */ @NonNullByDefault public class NukiSmartLockHandler extends AbstractNukiDeviceHandler { diff --git a/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/communication/NuvoConnector.java b/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/communication/NuvoConnector.java index 6ce667192c7b7..81b3cf3c22b52 100644 --- a/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/communication/NuvoConnector.java +++ b/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/communication/NuvoConnector.java @@ -110,7 +110,7 @@ protected void setConnected(boolean connected) { /** * Tell the connector if the device is an Essentia G or not * - * @param true if the device is an Essentia G + * @param isEssentia true if the device is an Essentia G */ public void setEssentia(boolean isEssentia) { this.isEssentia = isEssentia; @@ -119,7 +119,7 @@ public void setEssentia(boolean isEssentia) { /** * Tell the connector to listen for NuvoNet source messages * - * @param true if any sources are configured as openHAB NuvoNet sources + * @param isAnyOhNuvoNet true if any sources are configured as openHAB NuvoNet sources */ public void setAnyOhNuvoNet(boolean isAnyOhNuvoNet) { this.isAnyOhNuvoNet = isAnyOhNuvoNet; diff --git a/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/handler/NuvoHandler.java b/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/handler/NuvoHandler.java index d3ac3c1f23ecb..7ef3a7d2f1d49 100644 --- a/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/handler/NuvoHandler.java +++ b/bundles/org.openhab.binding.nuvo/src/main/java/org/openhab/binding/nuvo/internal/handler/NuvoHandler.java @@ -669,7 +669,7 @@ private synchronized void closeConnection() { /** * Handle an event received from the Nuvo device * - * @param event the event to process + * @param evt the event to process */ @Override public void onNewMessageEvent(NuvoMessageEvent evt) { diff --git a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterAlertWebClient.java b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterAlertWebClient.java index cff746622e8bd..0fa89d4e41955 100644 --- a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterAlertWebClient.java +++ b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterAlertWebClient.java @@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link WebClient} class contains the logic to get data from a URL. + * The {@link WaterAlertWebClient} class contains the logic to get data from a URL. * * @author Stewart Cossey - Initial contribution */ diff --git a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterWebService.java b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterWebService.java index b9e202ce53c80..3acb9ca657b6c 100644 --- a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterWebService.java +++ b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/api/WaterWebService.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link WebService} class contains the common interfaces for the different + * The {@link WaterWebService} class contains the common interfaces for the different * services. * * @author Stewart Cossey - Initial contribution diff --git a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinder.java b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinder.java index e8d5e5d6a9b99..b05fb7ede0884 100644 --- a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinder.java +++ b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinder.java @@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link NZWaterAlertsController} is responsible for handling the connection + * The {@link NZWaterAlertsBinder} is responsible for handling the connection * between the handler and API. * * @author Stewart Cossey - Initial contribution diff --git a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinderListener.java b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinderListener.java index 696cefe1ca2fe..efa37afa2b752 100644 --- a/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinderListener.java +++ b/bundles/org.openhab.binding.nzwateralerts/src/main/java/org/openhab/binding/nzwateralerts/internal/binder/NZWaterAlertsBinderListener.java @@ -17,7 +17,7 @@ import org.openhab.core.thing.ThingStatusDetail; /** - * The {@link NZWaterAlertsControllerListener} is responsible for handling the events from the WebClient and Handler. + * # * The {@link NZWaterAlertsBinderListener} is responsible for handling the events from the WebClient and Handler. * * @author Stewart Cossey - Initial contribution */ diff --git a/bundles/org.openhab.binding.oceanic/src/main/java/org/openhab/binding/oceanic/internal/OceanicBindingConstants.java b/bundles/org.openhab.binding.oceanic/src/main/java/org/openhab/binding/oceanic/internal/OceanicBindingConstants.java index b391c702ee1fb..56efa13111057 100644 --- a/bundles/org.openhab.binding.oceanic/src/main/java/org/openhab/binding/oceanic/internal/OceanicBindingConstants.java +++ b/bundles/org.openhab.binding.oceanic/src/main/java/org/openhab/binding/oceanic/internal/OceanicBindingConstants.java @@ -12,7 +12,6 @@ */ package org.openhab.binding.oceanic.internal; -import java.io.InvalidClassException; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; @@ -26,7 +25,7 @@ import org.openhab.core.types.Type; /** - * The {@link OceanicBinding} class defines common constants, which are used + * The {@link OceanicBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Karel Goderis - Initial contribution @@ -270,7 +269,7 @@ public boolean isProperty() { * * @param valueSelectorText selector string e.g. RawData, Command, Temperature * @return corresponding selector value. - * @throws InvalidClassException Not valid class for value selector. + * @throws IllegalArgumentException Not valid class for value selector. */ public static OceanicChannelSelector getValueSelector(String valueSelectorText, ValueSelectorType valueSelectorType) throws IllegalArgumentException { diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/BindingConstants.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/BindingConstants.java index 94570bef33195..1cf90d21df109 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/BindingConstants.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/BindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link OJElectronicsBindingConstants} class defines common constants, which are + * The {@link BindingConstants} class defines common constants, which are * used across the whole binding. * * @author Christian Kittel - Initial contribution diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/ThermostatHandlerFactory.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/ThermostatHandlerFactory.java index 6e7ea95dedf7c..3bffa7efd830c 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/ThermostatHandlerFactory.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/ThermostatHandlerFactory.java @@ -29,7 +29,7 @@ import org.osgi.service.component.annotations.Reference; /** - * The {@link ThermostatHandlerFactory} is responsible for creating {@link OJElectronicsThermostatHandler}. + * The {@link ThermostatHandlerFactory} is responsible for creating {@link ThermostatHandler}. * * @author Christian Kittel - Initial contribution */ @@ -43,7 +43,7 @@ public class ThermostatHandlerFactory extends BaseThingHandlerFactory { /** * Creates a new factory * - * @param httpClientFactory Factory for HttpClient + * @param timeZoneProvider */ @Activate public ThermostatHandlerFactory(@Reference TimeZoneProvider timeZoneProvider) { diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/common/OJGSonBuilder.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/common/OJGSonBuilder.java index fe0c7fbca5e41..d50bb5403c528 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/common/OJGSonBuilder.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/common/OJGSonBuilder.java @@ -29,7 +29,7 @@ public final class OJGSonBuilder { /** * Gets a correct initialized {@link Gson} * - * @return {@link GSon} + * @return {@link com.google.gson.GSon} */ public static Gson getGSon() { return new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).setPrettyPrinting() diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsBridgeConfiguration.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsBridgeConfiguration.java index 9e67b076d3138..5c0aab15cabff 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsBridgeConfiguration.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsBridgeConfiguration.java @@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsCloudHandler} + * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJCloudHandler} * * @author Christian Kittel - Initial contribution */ diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsThermostatConfiguration.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsThermostatConfiguration.java index 22acde44290e1..10c76a7062836 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsThermostatConfiguration.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/config/OJElectronicsThermostatConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsThermostatHandler} + * The configuration for {@link org.openhab.binding.ojelectronics.internal.ThermostatHandler} * * @author Christian Kittel - Initial contribution */ diff --git a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/services/RefreshService.java b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/services/RefreshService.java index c1eec05174cc9..510a6aa553809 100644 --- a/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/services/RefreshService.java +++ b/bundles/org.openhab.binding.ojelectronics/src/main/java/org/openhab/binding/ojelectronics/internal/services/RefreshService.java @@ -65,7 +65,6 @@ public final class RefreshService implements AutoCloseable { * * @param config Configuration of the bridge * @param httpClient HTTP client - * @param updateService Service to update the thermostat in the cloud */ public RefreshService(OJElectronicsBridgeConfiguration config, HttpClient httpClient) { this.config = config; @@ -78,7 +77,7 @@ public RefreshService(OJElectronicsBridgeConfiguration config, HttpClient httpCl * * @param sessionId Session-Id * @param refreshDone This method is called if refreshing is done. - * @param connectionLosed This method is called if no connection could established. + * @param connectionLost This method is called if no connection could established. * @param unauthorized This method is called if the result is unauthorized. */ public void start(String sessionId, diff --git a/bundles/org.openhab.binding.omnilink/src/main/java/org/openhab/binding/omnilink/internal/handler/AbstractOmnilinkHandler.java b/bundles/org.openhab.binding.omnilink/src/main/java/org/openhab/binding/omnilink/internal/handler/AbstractOmnilinkHandler.java index f3d30442c4a21..3b1f03d0e5581 100644 --- a/bundles/org.openhab.binding.omnilink/src/main/java/org/openhab/binding/omnilink/internal/handler/AbstractOmnilinkHandler.java +++ b/bundles/org.openhab.binding.omnilink/src/main/java/org/openhab/binding/omnilink/internal/handler/AbstractOmnilinkHandler.java @@ -73,7 +73,7 @@ protected void sendOmnilinkCommand(int message, int param1, int param2) { /** * Calculate the area filter the a supplied area * - * @param area Area to calculate filter for. + * @param areaProperties Area to calculate filter for. * @return Calculated Bit Filter for the supplied area. Bit 0 is area 1, bit 2 is area 2 and so on. */ protected static int bitFilterForArea(AreaProperties areaProperties) { diff --git a/bundles/org.openhab.binding.onebusaway/src/main/java/org/openhab/binding/onebusaway/internal/OneBusAwayBindingConstants.java b/bundles/org.openhab.binding.onebusaway/src/main/java/org/openhab/binding/onebusaway/internal/OneBusAwayBindingConstants.java index 573fcb61babe8..41b294d4385a4 100644 --- a/bundles/org.openhab.binding.onebusaway/src/main/java/org/openhab/binding/onebusaway/internal/OneBusAwayBindingConstants.java +++ b/bundles/org.openhab.binding.onebusaway/src/main/java/org/openhab/binding/onebusaway/internal/OneBusAwayBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link OneBusAwayBinding} class defines common constants, which are + * The {@link OneBusAwayBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Shawn Wilsher - Initial contribution diff --git a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/owserver/OwserverConnectionState.java b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/owserver/OwserverConnectionState.java index 14c2614e2a1af..71725b0f3c594 100644 --- a/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/owserver/OwserverConnectionState.java +++ b/bundles/org.openhab.binding.onewire/src/main/java/org/openhab/binding/onewire/internal/owserver/OwserverConnectionState.java @@ -35,7 +35,7 @@ public enum OwserverConnectionState { /** * The connection is erroneous and was closed by the {@link OwserverConnection}. After due wait time, it * is tried to reopen it by a scheduled task of - * {@link OwserverBridgeHandler#reportConnectionState(OwserverConnectionState)}. + * {@link org.openhab.binding.onewire.internal.handler.OwserverBridgeHandler#reportConnectionState(OwserverConnectionState)}. */ FAILED } diff --git a/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/OnkyoBindingConstants.java b/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/OnkyoBindingConstants.java index 5e4536ff05c3a..84786d985104c 100644 --- a/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/OnkyoBindingConstants.java +++ b/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/OnkyoBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link OnkyoBinding} class defines common constants, which are + * The {@link OnkyoBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Paul Frank - Initial contribution diff --git a/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/config/OnkyoDeviceConfiguration.java b/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/config/OnkyoDeviceConfiguration.java index b1bd5991642df..f2a5a8d6ab665 100644 --- a/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/config/OnkyoDeviceConfiguration.java +++ b/bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/config/OnkyoDeviceConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.onkyo.internal.config; /** - * Configuration class for {@link OnkyoBinding} device. + * Configuration class for Onkyo device. * * @author Pauli Anttila - Initial contribution */ diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/OpenSprinklerBindingConstants.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/OpenSprinklerBindingConstants.java index ad0e1abd7179d..c698e4ec21887 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/OpenSprinklerBindingConstants.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/OpenSprinklerBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link OpenSprinklerBinding} class defines common constants, which are + * The {@link OpenSprinklerBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Chris Graham - Initial contribution 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 eace11a85124d..bce904a0e4839 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 @@ -47,14 +47,16 @@ public interface OpenSprinklerApi { /** * Enters the "manual" mode of the device so that API requests are accepted. * - * @throws Exception + * @throws CommunicationApiException + * @throws UnauthorizedApiException */ void enterManualMode() throws CommunicationApiException, UnauthorizedApiException; /** * Disables the manual mode, if it is enabled. * - * @throws Exception + * @throws CommunicationApiException + * @throws UnauthorizedApiException */ void leaveManualMode() throws CommunicationApiException, UnauthorizedApiException; @@ -63,7 +65,8 @@ public interface OpenSprinklerApi { * * @param station Index of the station to open starting at 0. * @param duration The duration in seconds for how long the station should be turned on. - * @throws Exception + * @throws CommunicationApiException + * @throws GeneralApiException */ void openStation(int station, BigDecimal duration) throws CommunicationApiException, GeneralApiException; @@ -71,7 +74,8 @@ public interface OpenSprinklerApi { * Closes a station on the OpenSprinkler device. * * @param station Index of the station to open starting at 0. - * @throws Exception + * @throws CommunicationApiException + * @throws GeneralApiException */ void closeStation(int station) throws CommunicationApiException, GeneralApiException; @@ -80,7 +84,8 @@ public interface OpenSprinklerApi { * * @param station Index of the station to open starting at 0. * @return True if the station is open, false if it is closed or cannot determine. - * @throws Exception + * @throws CommunicationApiException + * @throws GeneralApiException */ boolean isStationOpen(int station) throws CommunicationApiException, GeneralApiException; @@ -89,7 +94,7 @@ public interface OpenSprinklerApi { * * @param station Index of the station to request data from * @return StationProgram - * @throws Exception + * @throws CommunicationApiException */ StationProgram retrieveProgram(int station) throws CommunicationApiException; @@ -97,7 +102,6 @@ public interface OpenSprinklerApi { * Returns the state of rain detection on the OpenSprinkler device. * * @return True if rain is detected, false if not or cannot determine. - * @throws Exception */ boolean isRainDetected(); @@ -161,7 +165,8 @@ public interface OpenSprinklerApi { * Returns the firmware version number. * * @return The firmware version of the OpenSprinkler device as an int. - * @throws Exception + * @throws CommunicationApiException + * @throws UnauthorizedApiException */ int getFirmwareVersion() throws CommunicationApiException, UnauthorizedApiException; @@ -199,7 +204,7 @@ public interface OpenSprinklerApi { /** * Runs a Program that is setup and stored inside the OpenSprinkler * - * @param Program index number that you wish to run. + * @param command Program index number that you wish to run. * * @throws CommunicationApiException * @throws UnauthorizedApiException diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApiFactory.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApiFactory.java index cd4ab8abad6e3..4e6bad47d53a9 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApiFactory.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApiFactory.java @@ -47,13 +47,10 @@ public OpenSprinklerApiFactory(@Reference HttpClientFactory httpClientFactory) { * Factory method used to determine what version of the API is in use at the * OpenSprinkler API and return the proper class for control of the device. * - * @param hostname Hostname or IP address as a String of the OpenSprinkler device. - * @param port The port number the OpenSprinkler API is listening on. - * @param password Admin password for the OpenSprinkler device. - * @param basicUsername Used when basic auth is required - * @param basicPassword Used when basic auth is required + * @param config Interface settings * @return OpenSprinkler HTTP API class for control of the device. - * @throws Exception + * @throws CommunicationApiException + * @throws GeneralApiException */ public OpenSprinklerApi getHttpApi(OpenSprinklerHttpInterfaceConfig config) throws CommunicationApiException, GeneralApiException { diff --git a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java index f4bbf2bcfda7e..b76cc544cbc8f 100644 --- a/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java +++ b/bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV210.java @@ -131,7 +131,8 @@ public void closeStation(int station) throws CommunicationApiException, GeneralA /** * {@inheritDoc} * - * @throws Exception + * @throws CommunicationApiException + * @throws UnauthorizedApiException */ @Override public void enterManualMode() throws CommunicationApiException, UnauthorizedApiException { @@ -150,7 +151,7 @@ public void leaveManualMode() { * * @param returnContent String value of the return content from the OpenSprinkler device when * an action result is returned from the API. - * @throws Exception Returns a custom exception based on the result key. + * @throws GeneralApiException Returns a custom exception based on the result key. */ protected void resultParser(String returnContent) throws GeneralApiException { int returnCode; diff --git a/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/discovery/OpenWebNetDeviceDiscoveryService.java b/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/discovery/OpenWebNetDeviceDiscoveryService.java index c7dc04aa0afda..6e83e5c56703c 100644 --- a/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/discovery/OpenWebNetDeviceDiscoveryService.java +++ b/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/discovery/OpenWebNetDeviceDiscoveryService.java @@ -96,7 +96,7 @@ public void abortScan() { * * @param where the discovered device's address (WHERE) * @param deviceType {@link OpenDeviceType} of the discovered device - * @param message the OWN message received that identified the device + * @param baseMsg the OWN message received that identified the device * (optional) */ public void newDiscoveryResult(@Nullable Where where, OpenDeviceType deviceType, diff --git a/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetBridgeHandler.java b/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetBridgeHandler.java index 05139bded4be4..7707d01c7a88a 100644 --- a/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetBridgeHandler.java +++ b/bundles/org.openhab.binding.openwebnet/src/main/java/org/openhab/binding/openwebnet/internal/handler/OpenWebNetBridgeHandler.java @@ -273,8 +273,6 @@ public Collection> getServices() { /** * Search for devices connected to this bridge handler's gateway - * - * @param listener to receive device found notifications */ public synchronized void searchDevices() { scanIsActive = true; diff --git a/bundles/org.openhab.binding.oppo/src/main/java/org/openhab/binding/oppo/internal/handler/OppoHandler.java b/bundles/org.openhab.binding.oppo/src/main/java/org/openhab/binding/oppo/internal/handler/OppoHandler.java index a137f8cb9efc4..7deadd0c52ee9 100644 --- a/bundles/org.openhab.binding.oppo/src/main/java/org/openhab/binding/oppo/internal/handler/OppoHandler.java +++ b/bundles/org.openhab.binding.oppo/src/main/java/org/openhab/binding/oppo/internal/handler/OppoHandler.java @@ -366,7 +366,7 @@ private synchronized void closeConnection() { /** * Handle an event received from the Oppo player * - * @param event the event to process + * @param evt the event to process */ @Override public void onNewMessageEvent(OppoMessageEvent evt) { diff --git a/bundles/org.openhab.binding.pentair/src/main/java/org/openhab/binding/pentair/internal/handler/PentairEasyTouchHandler.java b/bundles/org.openhab.binding.pentair/src/main/java/org/openhab/binding/pentair/internal/handler/PentairEasyTouchHandler.java index cb0e47f97049d..f66877d096971 100644 --- a/bundles/org.openhab.binding.pentair/src/main/java/org/openhab/binding/pentair/internal/handler/PentairEasyTouchHandler.java +++ b/bundles/org.openhab.binding.pentair/src/main/java/org/openhab/binding/pentair/internal/handler/PentairEasyTouchHandler.java @@ -187,7 +187,7 @@ public void circuitSwitch(int circuit, boolean state) { /** * Method to set heat point for pool (true) of spa (false) * - * @param Pool pool=true, spa=false + * @param pool pool=true, spa=false * @param temp */ public void setPoint(boolean pool, int temp) { diff --git a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCBindingConstants.java b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCBindingConstants.java index cc93474a069bf..0b2784499c015 100644 --- a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCBindingConstants.java +++ b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link PHCBinding} class defines common constants, which are used across + * The {@link PHCBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Jonas Hohaus - Initial contribution diff --git a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java index ab02283e0ba62..0bef3dc33b207 100644 --- a/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java +++ b/bundles/org.openhab.binding.phc/src/main/java/org/openhab/binding/phc/internal/PHCHelper.java @@ -44,7 +44,7 @@ public static ThingUID getThingUIDreverse(ThingTypeUID thingTypeUID, byte module /** * Convert the byte b into a binary String * - * @param b + * @param bytes * @return */ public static Object bytesToBinaryString(byte[] bytes) { diff --git a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/PioneerAvrBindingConstants.java b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/PioneerAvrBindingConstants.java index 7cbd57d341a5c..87062fa6d9014 100644 --- a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/PioneerAvrBindingConstants.java +++ b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/PioneerAvrBindingConstants.java @@ -22,7 +22,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link PioneerAvrBinding} class defines common constants, which are used across the whole binding. + * The {@link PioneerAvrBindingConstants} class defines common constants, which are used across the whole binding. * * @author Antoine Besnard - Initial contribution * @author Leroy Foerster - Listening Mode, Playing Listening Mode diff --git a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/DisplayInformation.java b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/DisplayInformation.java index eb654d53d40f6..195d54a111544 100644 --- a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/DisplayInformation.java +++ b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/DisplayInformation.java @@ -33,8 +33,6 @@ public class DisplayInformation { * parse the display status text send from the receiver * * @param responsePayload the responses payload, that is without the leading "FL" - * - * @return */ public DisplayInformation(String responsePayload) { volumeDisplay = false; diff --git a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/RequestResponseFactory.java b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/RequestResponseFactory.java index 338073b7f3ea9..85cae24597ffd 100644 --- a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/RequestResponseFactory.java +++ b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/RequestResponseFactory.java @@ -84,7 +84,6 @@ public static ParameterizedCommand getIpControlCommand(ParameterizedCommandType * * @param command * @param parameter - * @param zone * @return */ public static ParameterizedCommand getIpControlCommand(ParameterizedCommandType command, String parameter) { diff --git a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/avr/AvrConnection.java b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/avr/AvrConnection.java index 8909c7bb26eba..a4c8fb7e4bafe 100644 --- a/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/avr/AvrConnection.java +++ b/bundles/org.openhab.binding.pioneeravr/src/main/java/org/openhab/binding/pioneeravr/internal/protocol/avr/AvrConnection.java @@ -152,7 +152,6 @@ public interface AvrConnection { * Send an MCACC Memory selection command to the AVR based on the openHAB command * * @param command - * @param zone * @return */ boolean sendMCACCMemoryCommand(Command command) throws CommandTypeNotSupportedException; diff --git a/bundles/org.openhab.binding.pixometer/src/main/java/org/openhab/binding/pixometer/internal/data/MeterState.java b/bundles/org.openhab.binding.pixometer/src/main/java/org/openhab/binding/pixometer/internal/data/MeterState.java index 9663c261d1832..e104e13f35f40 100644 --- a/bundles/org.openhab.binding.pixometer/src/main/java/org/openhab/binding/pixometer/internal/data/MeterState.java +++ b/bundles/org.openhab.binding.pixometer/src/main/java/org/openhab/binding/pixometer/internal/data/MeterState.java @@ -32,8 +32,7 @@ public class MeterState { /** * Initialize times from the given timestamps * - * @param lastReadingDate time of last reading as ZonedDateTime - * @param lastRefreshTime time of last refresh as ZonedDateTime + * @param reading last reading */ public MeterState(ReadingInstance reading) { this.readingValue = reading.getValue(); diff --git a/bundles/org.openhab.binding.playstation/src/main/java/org/openhab/binding/playstation/internal/PS4ArtworkHandler.java b/bundles/org.openhab.binding.playstation/src/main/java/org/openhab/binding/playstation/internal/PS4ArtworkHandler.java index 024aa6a0c1391..b3860704583d5 100644 --- a/bundles/org.openhab.binding.playstation/src/main/java/org/openhab/binding/playstation/internal/PS4ArtworkHandler.java +++ b/bundles/org.openhab.binding.playstation/src/main/java/org/openhab/binding/playstation/internal/PS4ArtworkHandler.java @@ -90,7 +90,7 @@ private static String buildArtworkRequest(Locale locale, String titleId, Integer * Fetch artwork for PS4 application. First looks for the file on disc, if the file is not on the disc it checks * PlayStation store * - * @param titleid Title ID of application. + * @param titleId Title ID of application. * @param size Size (width & height) of art work in pixels , max 1024. * @param locale Locale used on PlayStation store to find art work. * @return A JPEG image as a RawType if an art work file is found otherwise null. @@ -103,7 +103,7 @@ private static String buildArtworkRequest(Locale locale, String titleId, Integer * Fetch artwork for PS4 application. First looks for the file on disc, if the file is not on the disc it checks * PlayStation store * - * @param titleid Title ID of application. + * @param titleId Title ID of application. * @param size Size (width & height) of art work in pixels , max 1024. * @param locale Locale used on PlayStation store to find art work. * @param forceRefetch When true, tries to re-fetch art work from PlayStation store, sometimes the art work is diff --git a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCAnalogConfiguration.java b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCAnalogConfiguration.java index 2c493f2ec2fb0..514ec282b76d1 100644 --- a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCAnalogConfiguration.java +++ b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCAnalogConfiguration.java @@ -39,7 +39,7 @@ public Integer getThreshold() { /** * Set Siemens LOGO! blocks update threshold. * - * @param force Force update of Siemens LOGO! blocks + * @param threshold */ public void setThreshold(final Integer threshold) { this.threshold = threshold; diff --git a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCDateTimeConfiguration.java b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCDateTimeConfiguration.java index efe03595544da..30440c70acbe2 100644 --- a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCDateTimeConfiguration.java +++ b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCDateTimeConfiguration.java @@ -58,7 +58,7 @@ public String getBlockType() { /** * Set Siemens LOGO! block name. * - * @param name Siemens LOGO! output block name + * @param type Siemens LOGO! output block type */ public void setBlockType(final String type) { this.type = type.trim(); diff --git a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCMemoryConfiguration.java b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCMemoryConfiguration.java index 82e7c0d0c5977..e73e36f85a26d 100644 --- a/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCMemoryConfiguration.java +++ b/bundles/org.openhab.binding.plclogo/src/main/java/org/openhab/binding/plclogo/internal/config/PLCMemoryConfiguration.java @@ -58,7 +58,7 @@ public Integer getThreshold() { /** * Set Siemens LOGO! blocks update threshold. * - * @param force Force update of Siemens LOGO! blocks + * @param threshold */ public void setThreshold(final Integer threshold) { this.threshold = threshold; diff --git a/bundles/org.openhab.binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexPlayerHandler.java b/bundles/org.openhab.binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexPlayerHandler.java index 788471f5d8b7b..b8dd9578d46f2 100644 --- a/bundles/org.openhab.binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexPlayerHandler.java +++ b/bundles/org.openhab.binding.plex/src/main/java/org/openhab/binding/plex/internal/handler/PlexPlayerHandler.java @@ -33,9 +33,8 @@ import org.slf4j.LoggerFactory; /** - * The {@link PlexBindingConstants} class defines common constants, which are - * used across the whole binding. - * + * Handler for Plex Player. + * * @author Brian Homeyer - Initial contribution * @author Aron Beurskens - Binding development */ diff --git a/bundles/org.openhab.binding.plugwise/src/main/java/org/openhab/binding/plugwise/internal/PlugwiseBindingConstants.java b/bundles/org.openhab.binding.plugwise/src/main/java/org/openhab/binding/plugwise/internal/PlugwiseBindingConstants.java index 54cf4c8cefe7a..877321264d0c6 100644 --- a/bundles/org.openhab.binding.plugwise/src/main/java/org/openhab/binding/plugwise/internal/PlugwiseBindingConstants.java +++ b/bundles/org.openhab.binding.plugwise/src/main/java/org/openhab/binding/plugwise/internal/PlugwiseBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link PlugwiseBinding} class defines common constants, which are used across the whole binding. + * The {@link PlugwiseBindingConstants} class defines common constants, which are used across the whole binding. * * @author Wouter Born - Initial contribution */ diff --git a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/api/model/dto/ActuatorFunctionalities.java b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/api/model/dto/ActuatorFunctionalities.java index 1c5f8e981df60..a10a2333b7c80 100644 --- a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/api/model/dto/ActuatorFunctionalities.java +++ b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/api/model/dto/ActuatorFunctionalities.java @@ -19,7 +19,7 @@ * The {@link ActuatorFunctionalities} class is an object model class that * mirrors the XML structure provided by the Plugwise Home Automation controller * for the collection of actuator functionalities. (e.g. 'offset', 'relay', et - * cetera). It extends the {@link CustomCollection} class. + * cetera). It extends the {@link PlugwiseHACollection} class. * * @author B. van Wetten - Initial contribution */ diff --git a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHABridgeThingConfig.java b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHABridgeThingConfig.java index 5a223ca55fac2..fff4a69080807 100644 --- a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHABridgeThingConfig.java +++ b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHABridgeThingConfig.java @@ -16,7 +16,7 @@ /** * The {@link PlugwiseHABridgeThingConfig} encapsulates all the configuration options for an instance of the - * {@link PlugwiseHABridgeHandler}. + * {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHABridgeHandler}. * * @author Bas van Wetten - Initial contribution * @author Leo Siepel - finish initial contribution diff --git a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHAThingConfig.java b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHAThingConfig.java index 495321e7ece23..f769025d310c3 100644 --- a/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHAThingConfig.java +++ b/bundles/org.openhab.binding.plugwiseha/src/main/java/org/openhab/binding/plugwiseha/internal/config/PlugwiseHAThingConfig.java @@ -16,8 +16,8 @@ /** * The {@link PlugwiseHAThingConfig} encapsulates the configuration options for - * an instance of the {@link PlugwiseHAApplianceHandler} and the - * {@link PlugwiseHAZoneHandler} + * an instance of the {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHAApplianceHandler} + * and the {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHAZoneHandler} * * @author Bas van Wetten - Initial contribution * @author Leo Siepel - finish initial contribution diff --git a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/PowermaxBindingConstants.java b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/PowermaxBindingConstants.java index 048f3504bf113..85e67c74ebc06 100644 --- a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/PowermaxBindingConstants.java +++ b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/PowermaxBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link PowermaxBinding} class defines common constants, which are + * The {@link PowermaxBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Laurent Garnier - Initial contribution diff --git a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnector.java b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnector.java index 8830f2731b60f..03cfbd7cd4aba 100644 --- a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnector.java +++ b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnector.java @@ -228,7 +228,7 @@ public synchronized long getWaitingForResponse() { /** * Set the start time of the time frame to receive a response * - * @param timeLastReceive the time in milliseconds + * @param waitingForResponse the time in milliseconds */ public synchronized void setWaitingForResponse(long waitingForResponse) { this.waitingForResponse = waitingForResponse; diff --git a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnectorInterface.java b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnectorInterface.java index 26eb55ff86228..9e090a6ffb190 100644 --- a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnectorInterface.java +++ b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxConnectorInterface.java @@ -38,7 +38,7 @@ public interface PowermaxConnectorInterface { /** * Returns connection status * - * @return: true if connected or false if not + * @return true if connected or false if not **/ boolean isConnected(); diff --git a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxReaderThread.java b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxReaderThread.java index 0076211e08905..391105c88fae0 100644 --- a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxReaderThread.java +++ b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/connector/PowermaxReaderThread.java @@ -41,7 +41,6 @@ public class PowermaxReaderThread extends Thread { /** * Constructor * - * @param in the input stream * @param connector the object that should handle the received message * @param threadName the name of the thread */ diff --git a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/message/PowermaxCommManager.java b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/message/PowermaxCommManager.java index 216da1db76445..c39e1601f1f15 100644 --- a/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/message/PowermaxCommManager.java +++ b/bundles/org.openhab.binding.powermax/src/main/java/org/openhab/binding/powermax/internal/message/PowermaxCommManager.java @@ -126,8 +126,8 @@ public PowermaxCommManager(String sPort, PowermaxPanelType panelType, boolean fo * @param panelType the panel type to be used when in standard mode * @param forceStandardMode true to force the standard mode rather than trying using the Powerlink mode * @param autoSyncTime true for automatic sync time - * @param serialPortManager * @param threadName the prefix name of threads to be created + * @param timeZoneProvider */ public PowermaxCommManager(String ip, int port, PowermaxPanelType panelType, boolean forceStandardMode, boolean autoSyncTime, String threadName, TimeZoneProvider timeZoneProvider) { @@ -163,8 +163,6 @@ public synchronized void removeEventListener(PowermaxStateEventListener listener /** * Connect to the Powermax alarm system - * - * @return true if connected or false if not */ public void open() throws Exception { connector.open(); @@ -201,7 +199,7 @@ public PowermaxPanelSettings getPanelSettings() { /** * Process and store all the panel settings from the raw buffers * - * @param PowerlinkMode true if in Powerlink mode or false if in standard mode + * @param powerlinkMode true if in Powerlink mode or false if in standard mode * * @return true if no problem encountered to get all the settings; false if not */ diff --git a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioBindingConstants.java b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioBindingConstants.java index aa920fb5ea228..9edc06818f2cf 100644 --- a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioBindingConstants.java +++ b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link PulseaudioBinding} class defines common constants, which are + * The {@link PulseaudioBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Tobias Bräutigam - Initial contribution diff --git a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioClient.java b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioClient.java index a0729193c3bc7..d32ddcf97649e 100644 --- a/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioClient.java +++ b/bundles/org.openhab.binding.pulseaudio/src/main/java/org/openhab/binding/pulseaudio/internal/PulseaudioClient.java @@ -264,7 +264,7 @@ public void sendCommand(String command) { * retrieves an {@link AbstractAudioDeviceConfig} by its identifier * If several devices correspond to the deviceIdentifier, returns the first one (aphabetical order) * - * @param The device identifier to match against + * @param deviceIdentifier The device identifier to match against * @return the corresponding {@link AbstractAudioDeviceConfig} to the given name */ public @Nullable AbstractAudioDeviceConfig getGenericAudioItem(DeviceIdentifier deviceIdentifier) { diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusBridgeHandler.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusBridgeHandler.java index 713c3c480c47a..ea6d4769de84d 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusBridgeHandler.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusBridgeHandler.java @@ -134,7 +134,6 @@ private void createCommunicationObject() { /** * Updates offline status off the Bridge when an error occurs. * - * @param status * @param detail * @param message */ diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusHandlerFactory.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusHandlerFactory.java index f3ae79af99f24..ce00305621b2d 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusHandlerFactory.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/QbusHandlerFactory.java @@ -31,7 +31,7 @@ import org.osgi.service.component.annotations.Component; /** - * The {@link qbusHandlerFactory} is responsible for creating things and thing + * The {@link QbusHandlerFactory} is responsible for creating things and thing * handlers. * * @author Koen Schockaert - Initial Contribution diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusBistabiel.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusBistabiel.java index ac2ae08970799..432477843ee3d 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusBistabiel.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusBistabiel.java @@ -51,7 +51,7 @@ public void setThingHandler(QbusBistabielHandler handler) { } /** - * This method sets a pointer to the qComm BISTABIEL of class {@link QbusCommuncation}. + * This method sets a pointer to the qComm BISTABIEL of class {@link QbusCommunication}. * This is then used to be able to call back the sendCommand method in this class to send a command to the * Qbus client. * diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusDimmer.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusDimmer.java index a01e3eebc6a86..30bf18f5f1c68 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusDimmer.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusDimmer.java @@ -51,7 +51,7 @@ public void setThingHandler(QbusDimmerHandler handler) { } /** - * This method sets a pointer to the qComm Dimmer of class {@link QbusCommuncation}. + * This method sets a pointer to the qComm Dimmer of class {@link QbusCommunication}. * This is then used to be able to call back the sendCommand method in this class to send a command to the * Qbus client. * diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusRol.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusRol.java index a88746f60fb6d..0fe8b8d62dcee 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusRol.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusRol.java @@ -54,7 +54,7 @@ public void setThingHandler(QbusRolHandler qbusRolHandler) { } /** - * This method sets a pointer to the qComm Shutter/Slats of class {@link QbusCommuncation}. + * This method sets a pointer to the qComm Shutter/Slats of class {@link QbusCommunication}. * This is then used to be able to call back the sendCommand method in this class to send a command to the * Qbus IP-interface when.. * @@ -67,7 +67,7 @@ public void setQComm(QbusCommunication qComm) { /** * Update the value of the Shutter. * - * @param Shutter value + * @param state Shutter value */ public void updateState(@Nullable Integer state) { this.state = state; @@ -80,7 +80,7 @@ public void updateState(@Nullable Integer state) { /** * Update the value of the Slats. * - * @param Slat value + * @param Slats slat value */ public void updateSlats(@Nullable Integer Slats) { this.slats = Slats; diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusScene.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusScene.java index b8d22e7d89670..45c7813ed8bad 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusScene.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusScene.java @@ -51,7 +51,7 @@ public void setThingHandler(QbusSceneHandler handler) { } /** - * This method sets a pointer to the qComm SCENE of class {@link QbusCommuncation}. + * This method sets a pointer to the qComm SCENE of class {@link QbusCommunication}. * This is then used to be able to call back the sendCommand method in this class to send a command to the * Qbus client. * diff --git a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusThermostat.java b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusThermostat.java index 92c0dc3fdaed8..266894160ff39 100644 --- a/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusThermostat.java +++ b/bundles/org.openhab.binding.qbus/src/main/java/org/openhab/binding/qbus/internal/protocol/QbusThermostat.java @@ -54,7 +54,7 @@ public void setThingHandler(QbusThermostatHandler handler) { } /** - * This method sets a pointer to the qComm THERMOSTAT of class {@link QbusCommuncation}. + * This method sets a pointer to the qComm THERMOSTAT of class {@link QbusCommunication}. * This is then used to be able to call back the sendCommand method in this class to send a command to the * Qbus client. * diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/AlarmAction.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/AlarmAction.java index 7cd3257ffb9df..3685f96c32246 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/AlarmAction.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/AlarmAction.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.action; /** - * An {@link ActionType.ALARM} type of {@link Action} message sent to the panel + * An {@link ActionType#ALARM} type of {@link Action} message sent to the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmAwayArmingAction.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmAwayArmingAction.java index 8097e475ef6c5..97b3e0c3ff50a 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmAwayArmingAction.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmAwayArmingAction.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.action; /** - * An {@link ArmingActionType.ARM_AWAY} type of {@link ArmingAction} message sent to the panel + * An {@link ArmingActionType#ARM_AWAY} type of {@link ArmingAction} message sent to the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmingAction.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmingAction.java index ffe657e9505ec..ee147a565dc45 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmingAction.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/ArmingAction.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.action; /** - * An {@link ActionType.ARMING} type of {@link ArmingAction} message sent to the panel + * An {@link ActionType#ARMING} type of {@link ArmingAction} message sent to the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/InfoAction.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/InfoAction.java index 00a75b5f99e9b..15c1ba07f788b 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/InfoAction.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/action/InfoAction.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.action; /** - * An {@link ActionType.INFO} type of {@link InfoAction} message sent to the panel + * An {@link ActionType#INFO} type of {@link InfoAction} message sent to the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/AlarmEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/AlarmEvent.java index 2938ab339533b..a1173a431aa3c 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/AlarmEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/AlarmEvent.java @@ -15,7 +15,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.AlarmType; /** - * An {@link EventType.ALARM} type of {@link Event} message sent from the panel + * An {@link EventType#ALARM} type of {@link Event} message sent from the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ArmingEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ArmingEvent.java index 0b251df2dbb56..a744dc55c0677 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ArmingEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ArmingEvent.java @@ -15,7 +15,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.PartitionStatus; /** - * An {@link EventType.ARMING} type of {@link Event} message sent from the panel + * An {@link EventType#ARMING} type of {@link Event} message sent from the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ErrorEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ErrorEvent.java index 9ab389b8482cc..a1008c7280d2c 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ErrorEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ErrorEvent.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.event; /** - * An {@link EventType.ERROR} type of {@link Event} message sent from the panel + * An {@link EventType#ERROR} type of {@link Event} message sent from the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/InfoEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/InfoEvent.java index 608850d2dedba..73b4c6741d774 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/InfoEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/InfoEvent.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.event; /** - * An {@link EventType.INFO} type of {@link Event} message sent by the panel + * An {@link EventType#INFO} type of {@link Event} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SecureArmInfoEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SecureArmInfoEvent.java index 13cc3057a87f0..60a5489049760 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SecureArmInfoEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SecureArmInfoEvent.java @@ -13,7 +13,7 @@ package org.openhab.binding.qolsysiq.internal.client.dto.event; /** - * A {@link InfoEventType.SECURE_ARM} type of {@link InfoEvent} message sent by the panel + * A {@link InfoEventType#SECURE_ARM} type of {@link InfoEvent} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SummaryInfoEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SummaryInfoEvent.java index 93de7bbd5fdae..4e060eece1f94 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SummaryInfoEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/SummaryInfoEvent.java @@ -17,7 +17,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.Partition; /** - * A {@link InfoEventType.SUMMARY} type of {@link InfoEvent} message sent by the panel + * A {@link InfoEventType#SUMMARY} type of {@link InfoEvent} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneActiveEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneActiveEvent.java index 3ff31aa8f8cdb..2a0689d3bbd60 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneActiveEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneActiveEvent.java @@ -15,7 +15,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.ZoneActiveState; /** - * A {@link ZoneEventType.ZONE_ACTIVE} type of {@link ZoneEvent} message sent by the panel + * A {@link ZoneEventType#ZONE_ACTIVE} type of {@link ZoneEvent} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneAddEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneAddEvent.java index 8559d6ee9f3a1..11da0079b340e 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneAddEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneAddEvent.java @@ -15,7 +15,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.Zone; /** - * A {@link ZoneEventType.ZONE_ADD} type of {@link ZoneEvent} message sent by the panel + * A {@link ZoneEventType#ZONE_ADD} type of {@link ZoneEvent} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneUpdateEvent.java b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneUpdateEvent.java index ea7c3f4c570b8..93fea0ef96575 100644 --- a/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneUpdateEvent.java +++ b/bundles/org.openhab.binding.qolsysiq/src/main/java/org/openhab/binding/qolsysiq/internal/client/dto/event/ZoneUpdateEvent.java @@ -15,7 +15,7 @@ import org.openhab.binding.qolsysiq.internal.client.dto.model.Zone; /** - * A {@link ZoneEventType.ZONE_UPDATE} type of {@link ZoneEvent} message sent by the panel + * A {@link ZoneEventType#ZONE_UPDATE} type of {@link ZoneEvent} message sent by the panel * * @author Dan Cunningham - Initial contribution */ diff --git a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatBindingConstants.java b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatBindingConstants.java index bcfbadce9287a..e2eb10f3fce40 100644 --- a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatBindingConstants.java +++ b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatBindingConstants.java @@ -25,7 +25,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link RadioThermostatBinding} class defines common constants, which are + * The {@link RadioThermostatBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Michael Lobstein - Initial contribution diff --git a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/communication/RadioThermostatConnector.java b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/communication/RadioThermostatConnector.java index be1d016de5f34..191645e790604 100644 --- a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/communication/RadioThermostatConnector.java +++ b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/communication/RadioThermostatConnector.java @@ -81,7 +81,7 @@ public void removeEventListener(RadioThermostatEventListener listener) { * Send an asynchronous http call to the thermostat, the response will be send to the * event listeners as a RadioThermostat event when it is finally received * - * @param resouce the url of the json resource on the thermostat + * @param resource the url of the json resource on the thermostat */ public void getAsyncThermostatData(String resource) { httpClient.newRequest(buildRequestURL(resource)).method(GET).timeout(30, TimeUnit.SECONDS) @@ -100,9 +100,9 @@ public void onComplete(@Nullable Result result) { /** * Sends a command to the thermostat * - * @param the JSON attribute key for the value to be updated - * @param the value to be updated in the thermostat - * @param the end point URI to use for the command + * @param cmdKey the JSON attribute key for the value to be updated + * @param cmdVal the value to be updated in the thermostat + * @param resource the end point URI to use for the command * @return the JSON response string from the thermostat */ public String sendCommand(String cmdKey, @Nullable String cmdVal, String resource) { @@ -112,10 +112,10 @@ public String sendCommand(String cmdKey, @Nullable String cmdVal, String resourc /** * Sends a command to the thermostat * - * @param the JSON attribute key for the value to be updated - * @param the value to be updated in the thermostat - * @param JSON string to send directly to the thermostat instead of a key/value pair - * @param the end point URI to use for the command + * @param cmdKey the JSON attribute key for the value to be updated + * @param cmdVal the value to be updated in the thermostat + * @param cmdJson JSON string to send directly to the thermostat instead of a key/value pair + * @param resource the end point URI to use for the command * @return the JSON response string from the thermostat */ public String sendCommand(@Nullable String cmdKey, @Nullable String cmdVal, @Nullable String cmdJson, diff --git a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/discovery/RadioThermostatDiscoveryService.java b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/discovery/RadioThermostatDiscoveryService.java index c05b30010422e..e8e40200662f1 100644 --- a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/discovery/RadioThermostatDiscoveryService.java +++ b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/discovery/RadioThermostatDiscoveryService.java @@ -191,12 +191,7 @@ private void sendDiscoveryBroacast(NetworkInterface ni) throws UnknownHostExcept * Scans all messages that arrive on the socket and scans them for the * search keywords. The search is not case sensitive. * - * @param socket - * The socket where the answers arrive. - * @param keywords - * The keywords to be searched for. - * @return - * @throws IOException + * @param response */ protected void parseResponse(String response) { diff --git a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/handler/RadioThermostatHandler.java b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/handler/RadioThermostatHandler.java index 819da52cd15fe..513bbbde5ee3f 100644 --- a/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/handler/RadioThermostatHandler.java +++ b/bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/handler/RadioThermostatHandler.java @@ -508,7 +508,7 @@ private void updateChannel(String channelId, RadioThermostatDTO rthermData) { /** * Update a given channelId from the thermostat data * - * @param the channel id to be updated + * @param channelId the channel id to be updated * @param data the RadioThermostat dto * @return the value to be set in the state */ diff --git a/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/RegoHeatPumpBindingConstants.java b/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/RegoHeatPumpBindingConstants.java index a4a808f60d874..f8b78d88b92a2 100644 --- a/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/RegoHeatPumpBindingConstants.java +++ b/bundles/org.openhab.binding.regoheatpump/src/main/java/org/openhab/binding/regoheatpump/internal/RegoHeatPumpBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link RegoHeatPumpBinding} class defines common constants, which are + * The {@link RegoHeatPumpBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Boris Krivonog - Initial contribution diff --git a/bundles/org.openhab.binding.rme/src/main/java/org/openhab/binding/rme/internal/RMEBindingConstants.java b/bundles/org.openhab.binding.rme/src/main/java/org/openhab/binding/rme/internal/RMEBindingConstants.java index f8a57d5a70a06..2c0358289fb10 100644 --- a/bundles/org.openhab.binding.rme/src/main/java/org/openhab/binding/rme/internal/RMEBindingConstants.java +++ b/bundles/org.openhab.binding.rme/src/main/java/org/openhab/binding/rme/internal/RMEBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link RMEBinding} class defines common constants, which are used across + * The {@link RMEBindingConstants} class defines common constants, which are used across * the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/RobonectClient.java b/bundles/org.openhab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/RobonectClient.java index a19b9f5bdec65..83f6befd2d758 100644 --- a/bundles/org.openhab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/RobonectClient.java +++ b/bundles/org.openhab.binding.robonect/src/main/java/org/openhab/binding/robonect/internal/RobonectClient.java @@ -183,7 +183,7 @@ private void addPreemptiveAuthentication(HttpClient httpClient, RobonectEndpoint } /** - * returns general mower information. See {@MowerInfo} for the detailed information. + * returns general mower information. See {@link MowerInfo} for the detailed information. * * @return - the general mower information including a general success status. */ diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/RussoundBindingConstants.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/RussoundBindingConstants.java index 661a546d99dc3..63918fee29196 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/RussoundBindingConstants.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/RussoundBindingConstants.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link RussoundBinding} class defines common constants, which are + * The {@link RussoundBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Tim Roberts - Initial contribution diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractBridgeHandler.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractBridgeHandler.java index d1adf99a12787..83ae5abb45da5 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractBridgeHandler.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractBridgeHandler.java @@ -186,7 +186,7 @@ protected void refreshNamedHandler(Gson gson, Class< } /** - * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the + * Overrides the base method to remove any state linked to the {@link ChannelUID} from the * {@link StatefulHandlerCallback} */ @Override diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractRioProtocol.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractRioProtocol.java index c92ac720b839c..3f6a1a4dca9e6 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractRioProtocol.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractRioProtocol.java @@ -117,8 +117,8 @@ public void dispose() { } /** - * Implements the {@link SocketSessionListener#responseException(Exception)} to automatically take the thing offline - * via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)} + * Implements the {@link SocketSessionListener#responseException(IOException)} to automatically take the thing + * offline via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)} * * @param e the exception */ diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractThingHandler.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractThingHandler.java index 632bdbeab97fa..6ec487e5df0d3 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractThingHandler.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/AbstractThingHandler.java @@ -109,7 +109,7 @@ public void bridgeStatusChanged(ThingStatusInfo bridgeStatusInfo) { } /** - * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the + * Overrides the base method to remove any state linked to the {@link ChannelUID} from the * {@link StatefulHandlerCallback} */ @Override diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioHandlerCallback.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioHandlerCallback.java index 06345b8015bf9..6678942dbdd89 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioHandlerCallback.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioHandlerCallback.java @@ -38,7 +38,7 @@ public interface RioHandlerCallback { * Callback to the bridge/thing to update the state of a channel in the bridge/thing. * * @param channelId the non-null, non-empty channel id - * @param state the new non-null {@State} + * @param state the new non-null {@link State} */ void stateChanged(String channelId, State state); diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java index 29dc9daf8c791..c4682f003b9d3 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioPresetsProtocol.java @@ -436,7 +436,7 @@ private void handlerSourceTypeNotification(Matcher m, String resp) { * Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the * russound system. This response may be for other protocol handler - so ignore if we don't recognize the response. * - * @param a possibly null, possibly empty response + * @param response a possibly null, possibly empty response */ @Override public void responseReceived(@Nullable String response) { diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java index bec67494118db..995013677d865 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/RioSystemFavoritesProtocol.java @@ -309,7 +309,7 @@ private void handleSystemFavoriteNotification(Matcher m, String resp) { * Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the * russound system. This response may be for other protocol handler - so ignore if we don't recognize the response. * - * @param a possibly null, possibly empty response + * @param response a possibly null, possibly empty response */ @Override public void responseReceived(@Nullable String response) { diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/controller/RioControllerHandler.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/controller/RioControllerHandler.java index 09c262ea5ae34..8bf3f29fab9c0 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/controller/RioControllerHandler.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/controller/RioControllerHandler.java @@ -125,7 +125,7 @@ private void handleRefresh(String id) { /** * Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a * {@link RioSystemHandler}. Once validated, a {@link RioControllerProtocol} is set via - * {@link #setProtocolHandler(RioControllerProtocol)} and the bridge comes online. + * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online. */ @Override public void initialize() { @@ -205,7 +205,7 @@ public void setProperty(String propertyName, String property) { } /** - * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names + * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names */ @Override public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) { @@ -213,7 +213,7 @@ public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) } /** - * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names + * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names */ @Override public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) { diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java index 6157b6071f65e..46c436077a979 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/models/RioPreset.java @@ -55,7 +55,7 @@ public RioPreset(int id) { * "Preset " + id * * @param id a preset ID between 1 and 36 - * @param isValid true if the preset is valid, false otherwise + * @param valid true if the preset is valid, false otherwise * @param name a possibly null, possibly empty preset name * @throws IllegalArgumentException if id < 1 or > 32 */ diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java index 1b84e68922a6e..b1d1355ddcb29 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/system/RioSystemHandler.java @@ -462,7 +462,7 @@ private void startScan(RioSystemConfig sysConfig) { } /** - * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names + * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names */ @Override public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) { @@ -470,7 +470,7 @@ public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) } /** - * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names + * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names */ @Override public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) { diff --git a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/zone/RioZoneHandler.java b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/zone/RioZoneHandler.java index b00ff37b9a360..2897aa4ad96d9 100644 --- a/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/zone/RioZoneHandler.java +++ b/bundles/org.openhab.binding.russound/src/main/java/org/openhab/binding/russound/internal/rio/zone/RioZoneHandler.java @@ -398,7 +398,7 @@ private void handleRefresh(String id) { /** * Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a * {@link RioControllerHandler}. Once validated, a {@link RioZoneProtocol} is set via - * {@link #setProtocolHandler(RioZoneProtocol)} and the bridge comes online. + * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online. */ @Override public void initialize() { diff --git a/bundles/org.openhab.binding.samsungtv/src/main/java/org/openhab/binding/samsungtv/internal/SamsungTvBindingConstants.java b/bundles/org.openhab.binding.samsungtv/src/main/java/org/openhab/binding/samsungtv/internal/SamsungTvBindingConstants.java index 9a274a4341a0b..ffe182874deb4 100644 --- a/bundles/org.openhab.binding.samsungtv/src/main/java/org/openhab/binding/samsungtv/internal/SamsungTvBindingConstants.java +++ b/bundles/org.openhab.binding.samsungtv/src/main/java/org/openhab/binding/samsungtv/internal/SamsungTvBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SamsungTvBinding} class defines common constants, which are used + * The {@link SamsungTvBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Pauli Anttila - Initial contribution diff --git a/bundles/org.openhab.binding.satel/src/main/java/org/openhab/binding/satel/internal/command/SatelCommandBase.java b/bundles/org.openhab.binding.satel/src/main/java/org/openhab/binding/satel/internal/command/SatelCommandBase.java index d39baf1dbf252..5321050f6e0de 100644 --- a/bundles/org.openhab.binding.satel/src/main/java/org/openhab/binding/satel/internal/command/SatelCommandBase.java +++ b/bundles/org.openhab.binding.satel/src/main/java/org/openhab/binding/satel/internal/command/SatelCommandBase.java @@ -55,7 +55,7 @@ public SatelCommandBase(byte commandCode, boolean extended) { /** * Creates new instance with specified command code and payload. * - * @param command command code + * @param commandCode command code * @param payload command payload */ public SatelCommandBase(byte commandCode, byte[] payload) { diff --git a/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/SEMSToken.java b/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/SEMSToken.java index ef9578ec5e880..ff441f4f8f221 100644 --- a/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/SEMSToken.java +++ b/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/SEMSToken.java @@ -13,7 +13,7 @@ package org.openhab.binding.semsportal.internal.dto; /** - * A token is returned in a successful {@Link LoginRequest} and is needed to authorize any subsequent requests. + * A token is returned in a successful {@link LoginRequest} and is needed to authorize any subsequent requests. * * @author Iwan Bron - Initial contribution */ diff --git a/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/Station.java b/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/Station.java index 342c9be8582d1..22132c88aabbb 100644 --- a/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/Station.java +++ b/bundles/org.openhab.binding.semsportal/src/main/java/org/openhab/binding/semsportal/internal/dto/Station.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * POJO for mapping the portal data response to the {@link StatusRequest} and the {@Link StationListRequest} + * POJO for mapping the portal data response to the {@link StatusRequest} and the {@link StationListRequest} * * @author Iwan Bron - Initial contribution * diff --git a/bundles/org.openhab.binding.seneye/src/main/java/org/openhab/binding/seneye/internal/SeneyeBindingConstants.java b/bundles/org.openhab.binding.seneye/src/main/java/org/openhab/binding/seneye/internal/SeneyeBindingConstants.java index 32def242e87f8..14c0a94ac9819 100644 --- a/bundles/org.openhab.binding.seneye/src/main/java/org/openhab/binding/seneye/internal/SeneyeBindingConstants.java +++ b/bundles/org.openhab.binding.seneye/src/main/java/org/openhab/binding/seneye/internal/SeneyeBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SeneyeBinding} class defines common constants, which are + * The {@link SeneyeBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Niko Tanghe - Initial contribution diff --git a/bundles/org.openhab.binding.sensorcommunity/src/main/java/org/openhab/binding/sensorcommunity/internal/dto/Location.java b/bundles/org.openhab.binding.sensorcommunity/src/main/java/org/openhab/binding/sensorcommunity/internal/dto/Location.java index 7b24edb566514..929de6fa3feab 100644 --- a/bundles/org.openhab.binding.sensorcommunity/src/main/java/org/openhab/binding/sensorcommunity/internal/dto/Location.java +++ b/bundles/org.openhab.binding.sensorcommunity/src/main/java/org/openhab/binding/sensorcommunity/internal/dto/Location.java @@ -15,7 +15,7 @@ import com.google.gson.annotations.SerializedName; /** - * The {@link SensorCommunity} class definition for Logging identification + * The SensorCommunity class definition for Logging identification * * @author Bernd Weymann - Initial contribution */ diff --git a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannel.java b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannel.java index dde85b003edf8..604e4bfecae4e 100644 --- a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannel.java +++ b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannel.java @@ -81,7 +81,7 @@ protected Optional transformCommand(final String data) { /** * Format the commnd using the configured format * - * @param data the command to transform + * @param command the command to transform * @return the formatted data. The orginal data is returned if there is no format string * or if there is an error performing the format. */ diff --git a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannelFactory.java b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannelFactory.java index f7928e2f8aa13..8134e40e0aa11 100644 --- a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannelFactory.java +++ b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/channel/DeviceChannelFactory.java @@ -33,7 +33,7 @@ public class DeviceChannelFactory { /** * Create a {@link DeviceChannel} for the channel type * - * @param bundleContext the bundle context + * @param valueTransformationProvider the transformation provider * @param channelConfig the channel configuration * @param channelTypeID the channel type id * @return the DeviceChannel or null if the channel type is not supported. diff --git a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/transform/SingleValueTransformation.java b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/transform/SingleValueTransformation.java index c9874798ee72a..7c681d292679e 100644 --- a/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/transform/SingleValueTransformation.java +++ b/bundles/org.openhab.binding.serial/src/main/java/org/openhab/binding/serial/internal/transform/SingleValueTransformation.java @@ -24,7 +24,7 @@ import org.slf4j.LoggerFactory; /** - * A transformation for a value used in {@DeviceChannel}. + * A transformation for a value used in {@link org.openhab.binding.serial.internal.channel.DeviceChannel}. * * @author David Graeff - Initial contribution * @author Jan N. Klug - adapted from MQTT binding to HTTP binding diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyApiException.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyApiException.java index c562c7fdc1d94..845219bf92c8b 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyApiException.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyApiException.java @@ -31,7 +31,7 @@ import com.google.gson.JsonSyntaxException; /** - * The {@link CarNetException} implements an extension to the standard Exception class. This allows to keep also the + * The {@link ShellyApiException} implements an extension to the standard Exception class. This allows to keep also the * result of the last API call (e.g. including the http status code in the message). * * @author Markus Michels - Initial contribution diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyEventServlet.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyEventServlet.java index 266575ed37c6e..330c7b5cc042f 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyEventServlet.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api/ShellyEventServlet.java @@ -45,7 +45,7 @@ import org.slf4j.LoggerFactory; /** - * {@link Shelly2RpcServlet} implements the WebSocket callback for Gen2 devices + * {@link ShellyEventServlet} implements the WebSocket callback for Gen2 devices * * @author Markus Michels - Initial contribution */ diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTProtocol.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTProtocol.java index 3b5603b9fcb0e..98f08ae3410e0 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTProtocol.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTProtocol.java @@ -232,7 +232,7 @@ protected void handleInputEvent(CoIotDescrSen sen, String type, int count, int s * @param id Sensor id from the update * @param sen Sensor description from the update * @param s New sensor value - * @param allUpdatesList of updates. This is required, because we need to update both values at the same time + * @param allUpdates List of updates. This is required, because we need to update both values at the same time */ protected void updatePower(ShellyDeviceProfile profile, Map updates, int id, CoIotDescrSen sen, CoIotSensor s, List allUpdates) { @@ -294,7 +294,7 @@ protected void updatePower(ShellyDeviceProfile profile, Map updat /** * Find index of Input id, which is required to map to channel name * - * @parm sensorDesc D field from sensor update + * @param sensorDesc D field from sensor update * @param sensorId The id from the sensor update * @return Index of found entry (+1 will be the suffix for the channel name) or null if sensorId is not found */ diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTVersion1.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTVersion1.java index d7116528dd6ea..4f4e6020576eb 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTVersion1.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoIoTVersion1.java @@ -57,11 +57,15 @@ public int getVersion() { * Process CoIoT status update message. If a status update is received, but the device description has not been * received yet a GET is send to query device description. * - * @param devId device id included in the status packet - * @param payload CoAP payload (Json format), example: {"G":[[0,112,0]]} + * @param sensorUpdates + * @param sen * @param serial Serial for this request. If this the the same as last serial * the update was already sent and processed so this one gets * ignored. + * @param serial + * @param s + * @param updates + * @param col */ @Override public boolean handleStatusUpdate(List sensorUpdates, CoIotDescrSen sen, int serial, CoIotSensor s, diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoapHandler.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoapHandler.java index 9d9992fd81c25..b3b88d71f1bff 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoapHandler.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1CoapHandler.java @@ -107,9 +107,9 @@ public Shelly1CoapHandler(ShellyThingInterface thingHandler, Shelly1CoapServer c /** * Initialize CoAP access, send discovery packet and start Status server * - * @parm thingName Thing name derived from Thing Type/hostname - * @parm config ShellyThingConfiguration - * @thows ShellyApiException + * @param thingName Thing name derived from Thing Type/hostname + * @param config ShellyThingConfiguration + * @throws ShellyApiException */ public synchronized void start(String thingName, ShellyThingConfiguration config) throws ShellyApiException { try { diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1HttpApi.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1HttpApi.java index d271e1c993b03..97d83ad7eea73 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1HttpApi.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api1/Shelly1HttpApi.java @@ -507,7 +507,6 @@ public void setSenseSetting(String setting, String value) throws ShellyApiExcept * Set event callback URLs. Depending on the device different event types are supported. In fact all of them will be * redirected to the binding's servlet and act as a trigger to schedule a status update * - * @param ShellyApiException * @throws ShellyApiException */ @Override diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api2/Shelly2RpctInterface.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api2/Shelly2RpctInterface.java index 4387db1413cd6..4e209ee64c5fd 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api2/Shelly2RpctInterface.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/api2/Shelly2RpctInterface.java @@ -17,7 +17,7 @@ import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2RpcNotifyStatus; /** - * The {@link WebsocketInterface} is responsible for interfacing the Websocket. + * The {@link Shelly2RpctInterface} is responsible for interfacing the Websocket. * * @author Markus Michels - Initial contribution */ diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java index 9cb3078df0ce0..54cd538c1a64c 100755 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java @@ -127,11 +127,12 @@ public abstract class ShellyBaseHandler extends BaseThingHandler * Constructor * * @param thing The Thing object + * @param translationProvider * @param bindingConfig The binding configuration (beside thing * configuration) + * @param thingTable * @param coapServer coap server instance - * @param localIP local IP address from networkAddressService - * @param httpPort from httpService + * @param httpClient from httpService */ public ShellyBaseHandler(final Thing thing, final ShellyTranslationProvider translationProvider, final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable, @@ -811,7 +812,8 @@ private boolean checkRestarted(ShellySettingsStatus status) { /** * Save alarm to the lastAlarm channel * - * @param alarm Alarm Message + * @param event Alarm Message + * @param force */ @Override public void postEvent(String event, boolean force) { @@ -851,9 +853,11 @@ public boolean isUpdateScheduled() { /** * Callback for device events * + * @param address * @param deviceName device receiving the event + * @param deviceIndex + * @param type the HTML input data * @param parameters parameters from the event URL - * @param data the HTML input data * @return true if event was processed */ @Override @@ -1123,7 +1127,7 @@ public void startCoap(ShellyThingConfiguration config, ShellyDeviceProfile profi * If the authorization failed the binding can't access the device settings and determine the thing type. In this * case the thing type shelly-unknown is set. * - * @param response exception details including the http respone + * @param result exception details including the http respone * @return true if the authorization failed */ protected boolean isAuthorizationFailed(ShellyApiResult result) { @@ -1202,8 +1206,6 @@ public boolean requestUpdates(int requestCount, boolean refreshSettings) { /** * Map input states to channels * - * @param groupName Channel Group (relay / relay1...) - * * @param status Shelly device status * @return true: one or more inputs were updated */ @@ -1313,7 +1315,7 @@ public double getChannelDouble(String group, String channel) { /** * Update Thing's channels according to available status information from the API * - * @param thingHandler + * @param dynChannels */ @Override public void updateChannelDefinitions(Map dynChannels) { @@ -1461,7 +1463,7 @@ public static Map fillDeviceProperties(ShellyDeviceProfile profi /** * Return device profile. * - * @param ForceRefresh true=force refresh before returning, false=return without + * @param forceRefresh true=force refresh before returning, false=return without * refresh * @return ShellyDeviceProfile instance * @throws ShellyApiException diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyComponents.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyComponents.java index 8e05ff4f594ac..cb2731efd9c85 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyComponents.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyComponents.java @@ -54,8 +54,8 @@ public class ShellyComponents { /** * Update device status * - * @param th Thing Handler instance - * @param profile ShellyDeviceProfile + * @param thingHandler Thing Handler instance + * @param status Status message */ public static boolean updateDeviceStatus(ShellyThingInterface thingHandler, ShellySettingsStatus status) { ShellyDeviceProfile profile = thingHandler.getProfile(); @@ -205,8 +205,7 @@ public static boolean updateRoller(ShellyBaseHandler thingHandler, ShellyRollerS /** * Update Meter channel * - * @param th Thing Handler instance - * @param profile ShellyDeviceProfile + * @param thingHandler Thing Handler instance * @param status Last ShellySettingsStatus */ public static boolean updateMeters(ShellyThingInterface thingHandler, ShellySettingsStatus status) { @@ -377,8 +376,7 @@ private static Double computePF(ShellySettingsEMeter emeter) { /** * Update Sensor channel * - * @param th Thing Handler instance - * @param profile ShellyDeviceProfile + * @param thingHandler Thing Handler instance * @param status Last ShellySettingsStatus * * @throws ShellyApiException diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyDeviceListener.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyDeviceListener.java index 98cbf7ea6d1f5..b330830dcd429 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyDeviceListener.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyDeviceListener.java @@ -17,7 +17,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * {@link DeviceUpdateListener} can register on the {@link TradfriGatewayHandler} to be informed about details about + * {@link ShellyDeviceListener} can register on the + * {@link org.openhab.binding.tradfri.internal.handler.TradfriGatewayHandler} to be informed about details about * devices. * * @author Markus Michels - Initial contribution diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyProtectedHandler.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyProtectedHandler.java index 6f1d28d7f7f6b..f5f7dfdadec32 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyProtectedHandler.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyProtectedHandler.java @@ -30,10 +30,11 @@ public class ShellyProtectedHandler extends ShellyBaseHandler { * Constructor * * @param thing The thing passed by the HandlerFactory + * @param translationProvider * @param bindingConfig configuration of the binding - * @param coapServer coap server instance - * @param localIP local IP of the openHAB host - * @param httpPort port of the openHAB HTTP API + * @param thingTable + * @param coapService coap server instance + * @param httpClient to connect to the openHAB HTTP API */ public ShellyProtectedHandler(final Thing thing, final ShellyTranslationProvider translationProvider, final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable, diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java index 93182b86ea900..aa432b0473cce 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java @@ -54,10 +54,11 @@ public class ShellyRelayHandler extends ShellyBaseHandler { * Constructor * * @param thing The thing passed by the HandlerFactory + * @param translationProvider * @param bindingConfig configuration of the binding + * @param thingTable * @param coapServer coap server instance - * @param localIP local IP of the openHAB host - * @param httpPort port of the openHAB HTTP API + * @param httpClient to connect to the openHAB HTTP API */ public ShellyRelayHandler(final Thing thing, final ShellyTranslationProvider translationProvider, final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable, @@ -304,8 +305,6 @@ private void createRollerChannels(ShellyRollerStatus roller) { /** * Update Relay/Roller channels * - * @param th Thing Handler instance - * @param profile ShellyDeviceProfile * @param status Last ShellySettingsStatus * * @throws ShellyApiException @@ -348,8 +347,6 @@ public boolean updateRelays(ShellySettingsStatus status) throws ShellyApiExcepti /** * Update LED channels * - * @param th Thing Handler instance - * @param profile ShellyDeviceProfile * @param status Last ShellySettingsStatus */ public boolean updateLed(ShellySettingsStatus status) { diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/provider/ShellyChannelDefinitions.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/provider/ShellyChannelDefinitions.java index 5dbaf024fa83e..5867336c800ac 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/provider/ShellyChannelDefinitions.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/provider/ShellyChannelDefinitions.java @@ -56,7 +56,7 @@ import org.osgi.service.component.annotations.Reference; /** - * The {@link ShellyCHANNEL_DEFINITIONSDTO} defines channel information for dynamically created channels. Those will be + * The {@link #CHANNEL_DEFINITIONS} defines channel information for dynamically created channels. Those will be * added on the first thing status update * * @author Markus Michels - Initial contribution diff --git a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/util/ShellyChannelCache.java b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/util/ShellyChannelCache.java index 513dff80f1441..30cafdef815be 100644 --- a/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/util/ShellyChannelCache.java +++ b/bundles/org.openhab.binding.shelly/src/main/java/org/openhab/binding/shelly/internal/util/ShellyChannelCache.java @@ -65,7 +65,7 @@ public synchronized void disable() { * messing up the log with those updates) * * @param channelId Channel id - * @param value Value (State) + * @param newValue Value (State) * @param forceUpdate true: ignore cached data, force update; false check cache of changed data * @return true, if successful */ diff --git a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/SilvercrestWifiSocketHandlerFactory.java b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/SilvercrestWifiSocketHandlerFactory.java index 1874962808fd1..ea37e4ef177ca 100644 --- a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/SilvercrestWifiSocketHandlerFactory.java +++ b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/SilvercrestWifiSocketHandlerFactory.java @@ -57,7 +57,7 @@ public void setMediator(final SilvercrestWifiSocketMediator mediator) { /** * Used by OSGI to unsets the mediator from the handler factory. * - * @param mediator the mediator + * @param mitsubishiMediator the mediator */ public void unsetMediator(final SilvercrestWifiSocketMediator mitsubishiMediator) { logger.debug("Mediator has been unsetted from discovery service."); diff --git a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/discovery/SilvercrestWifiSocketDiscoveryService.java b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/discovery/SilvercrestWifiSocketDiscoveryService.java index 75ca239f2d4c9..c6dde993498af 100644 --- a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/discovery/SilvercrestWifiSocketDiscoveryService.java +++ b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/discovery/SilvercrestWifiSocketDiscoveryService.java @@ -56,7 +56,7 @@ public void setMediator(final SilvercrestWifiSocketMediator mediator) { /** * Used by OSGI to unset the mediator in the discovery service. * - * @param mediator the mediator + * @param mitsubishiMediator the mediator */ public void unsetMediator(final SilvercrestWifiSocketMediator mitsubishiMediator) { logger.debug("Mediator has been unsetted from discovery service."); diff --git a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediator.java b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediator.java index d9bbce5f2e816..b49a0953eda60 100644 --- a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediator.java +++ b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediator.java @@ -53,7 +53,7 @@ public interface SilvercrestWifiSocketMediator { /** * Returns all the {@link Thing} registered. * - * @returns all the {@link Thing}. + * @return all the {@link Thing}. */ Set getAllThingsRegistred(); diff --git a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediatorImpl.java b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediatorImpl.java index 1a83253d2fab0..749f95435c1e1 100644 --- a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediatorImpl.java +++ b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/handler/SilvercrestWifiSocketMediatorImpl.java @@ -157,7 +157,7 @@ private void initMediatorWifiSocketUpdateReceiverRunnable() { /** * Returns all the {@link Thing} registered. * - * @returns all the {@link Thing}. + * @return all the {@link Thing}. */ @Override public Set getAllThingsRegistred() { diff --git a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/utils/ValidationUtils.java b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/utils/ValidationUtils.java index d8224cb502cdb..15a707e319bea 100644 --- a/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/utils/ValidationUtils.java +++ b/bundles/org.openhab.binding.silvercrestwifisocket/src/main/java/org/openhab/binding/silvercrestwifisocket/internal/utils/ValidationUtils.java @@ -44,7 +44,7 @@ public static boolean isMacValid(final String mac) { /** * Validates if one Mac address is not valid. * - * @param mac the mac, with or without : + * @param macAddress the mac, with or without : * @return true if is not valid. */ public static boolean isMacNotValid(final String macAddress) { diff --git a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/SinopeBindingConstants.java b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/SinopeBindingConstants.java index 6ef77bcd437d3..f4f45dcb8bca1 100644 --- a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/SinopeBindingConstants.java +++ b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/SinopeBindingConstants.java @@ -19,7 +19,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link sinopeBinding} class defines common constants, which are + * The {@link SinopeBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Pascal Larin - Initial contribution diff --git a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/SinopeConfigStatusMessage.java b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/SinopeConfigStatusMessage.java index 8dca79e47a3e7..b581f6ea0e84e 100644 --- a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/SinopeConfigStatusMessage.java +++ b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/SinopeConfigStatusMessage.java @@ -14,7 +14,7 @@ /** * The {@link SinopeConfigStatusMessage} defines - * the keys to be used for {@link ConfigStatusMessage}s. + * the keys to be used for {@link org.openhab.core.config.core.status.ConfigStatusMessage}s. * * @author Pascal Larin - Initial Contribution * diff --git a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/discovery/SinopeThingsDiscoveryService.java b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/discovery/SinopeThingsDiscoveryService.java index ddd6d0128e2ea..3eee402a00b8c 100644 --- a/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/discovery/SinopeThingsDiscoveryService.java +++ b/bundles/org.openhab.binding.sinope/src/main/java/org/openhab/binding/sinope/internal/discovery/SinopeThingsDiscoveryService.java @@ -31,7 +31,9 @@ * The {@link AbstractDiscoveryService} provides methods which handle the {@link DiscoveryListener}s. * * Subclasses do not have to care about adding and removing those listeners. - * They can use the protected methods {@link #thingDiscovered(DiscoveryResult)} and {@link #thingRemoved(String)} in + * They can use the protected methods + * {@link org.openhab.core.config.discovery.pAbstractDiscoveryService#thingDiscovered(DiscoveryResult)} + * and {@link org.openhab.core.config.discovery.AbstractDiscoveryService#thingRemoved(ThingUID)} in * order to notify the registered {@link DiscoveryListener}s. * * @author Pascal Larin - Initial contribution diff --git a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/SleepIQBindingConstants.java b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/SleepIQBindingConstants.java index 844d8bd9d42aa..8e173430b3aa7 100644 --- a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/SleepIQBindingConstants.java +++ b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/SleepIQBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SleepIQBinding} class defines common constants, which are + * The {@link SleepIQBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Gregory Moyer - Initial contribution diff --git a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/api/dto/SleepersResponse.java b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/api/dto/SleepersResponse.java index d482d4712be88..f526f2a745ff9 100644 --- a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/api/dto/SleepersResponse.java +++ b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/api/dto/SleepersResponse.java @@ -15,7 +15,7 @@ import java.util.List; /** - * The {@link SleeperResponse} holds the information about the sleepers assigned to the bed sides. + * The {@link SleepersResponse} holds the information about the sleepers assigned to the bed sides. * * @author Gregory Moyer - Initial contribution */ diff --git a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/handler/SleepIQCloudHandler.java b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/handler/SleepIQCloudHandler.java index 73b4e9fefd197..96a7cac8e39cd 100644 --- a/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/handler/SleepIQCloudHandler.java +++ b/bundles/org.openhab.binding.sleepiq/src/main/java/org/openhab/binding/sleepiq/internal/handler/SleepIQCloudHandler.java @@ -384,8 +384,9 @@ public Map updateProperties(final @Nullable Bed bed, Mapnull
    ) + * @param properties * @return the given map (or a new map if no map was given) with updated/set properties from the supplied bed */ public Map updateFeatures(final String bedId, final @Nullable FoundationFeaturesResponse features, diff --git a/bundles/org.openhab.binding.smaenergymeter/src/main/java/org/openhab/binding/smaenergymeter/internal/SMAEnergyMeterBindingConstants.java b/bundles/org.openhab.binding.smaenergymeter/src/main/java/org/openhab/binding/smaenergymeter/internal/SMAEnergyMeterBindingConstants.java index bccc1078d1282..43d3a0ef39643 100644 --- a/bundles/org.openhab.binding.smaenergymeter/src/main/java/org/openhab/binding/smaenergymeter/internal/SMAEnergyMeterBindingConstants.java +++ b/bundles/org.openhab.binding.smaenergymeter/src/main/java/org/openhab/binding/smaenergymeter/internal/SMAEnergyMeterBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SMAEnergyMeterBinding} class defines common constants, which are + * The {@link SMAEnergyMeterBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Osman Basha - Initial contribution diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/SmartMeterBindingConstants.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/SmartMeterBindingConstants.java index bfaeac087b3ff..1613501230ae5 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/SmartMeterBindingConstants.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/SmartMeterBindingConstants.java @@ -17,7 +17,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SmlReaderBinding} class defines common constants, which are + * The {@link SmartMeterBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Matthias Steigenberger - Initial contribution diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/connectors/IMeterReaderConnector.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/connectors/IMeterReaderConnector.java index 76b7720b2c117..c6ff776287f98 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/connectors/IMeterReaderConnector.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/connectors/IMeterReaderConnector.java @@ -33,8 +33,9 @@ public interface IMeterReaderConnector { * Establishes the connection against the device and reads native encoded SML informations. * Ensures that a connection is opened and notifies any attached listeners * - * @param serialParmeter + * @param initMessage * @param period hint for the connector to emit items in this time intervals. + * @param executor * @return native encoded SML informations from a device. */ Publisher getMeterValues(byte @Nullable [] initMessage, Duration period, ExecutorService executor); diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java index fb42dbd76b289..377439932347a 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/MeterDevice.java @@ -43,7 +43,7 @@ /** * This represents a meter device. * All read values of the device are cached here and can be obtained. The reading can be started with - * {@link #readValues(ScheduledExecutorService, Duration)} + * {@link #readValues(long, ScheduledExecutorService, Duration)} * * @author Matthias Steigenberger - Initial contribution * @@ -114,7 +114,7 @@ public String getDeviceId() { /** * Returns the specified OBIS value if available. * - * @param obis the OBIS code which value should be retrieved. + * @param obisId the OBIS code which value should be retrieved. * @return the OBIS value as String if available - otherwise null. */ @Nullable @@ -129,7 +129,7 @@ public String getValue(String obisId) { /** * Returns the specified OBIS value if available. * - * @param obis the OBIS code which value should be retrieved. + * @param obisId the OBIS code which value should be retrieved. * @return the OBIS value if available - otherwise null. */ @SuppressWarnings("unchecked") @@ -153,8 +153,9 @@ public Collection getObisCodes() { /** * Read values from this device a store them locally against their OBIS code. * - * If there is an error in reading, it will be retried {@value #NUMBER_OF_RETRIES} times. The retry will be delayed - * by {@code period} seconds. + * If there is an error in reading, it will be retried + * {@value org.openhab.binding.smartmeter.connectors.ConnectorBase#NUMBER_OF_RETRIES} times. + * The retry will be delayed by {@code period} seconds. * If its still failing, the connection will be closed and opened again. * * @return The {@link Disposable} which needs to be disposed whenever not used anymore. diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlMeterReader.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlMeterReader.java index acaf18e83030d..7c1cc802b69cc 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlMeterReader.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlMeterReader.java @@ -48,12 +48,11 @@ public final class SmlMeterReader extends MeterDevice { * Static factory method to create a SmlDevice object with a serial connector member. * * @param serialPortManagerSupplier - * * @param deviceId the id of the device as defined in openHAB configuration. - * @param pullRequestRequired identicates if SML values have to be actively requested. * @param serialPort the port where the device is connected as defined in openHAB configuration. - * @param serialParameter * @param initMessage + * @param baudrate + * @param baudrateChangeDelay */ public static SmlMeterReader createInstance(Supplier serialPortManagerSupplier, String deviceId, String serialPort, byte @Nullable [] initMessage, int baudrate, int baudrateChangeDelay) { diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlSerialConnector.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlSerialConnector.java index 81398309159d9..f7d34372042d9 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlSerialConnector.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlSerialConnector.java @@ -70,7 +70,6 @@ public SmlSerialConnector(Supplier serialPortManagerSupplier, * * @param portName the port where the device is connected as defined in openHAB configuration. * @param baudrate - * @throws IOException */ public SmlSerialConnector(Supplier serialPortManagerSupplier, String portName, int baudrate, int baudrateChangeDelay) { @@ -139,7 +138,7 @@ public void openConnection() throws IOException { } /** - * @{inheritDoc} + * {@inheritDoc} */ @Override public void closeConnection() { diff --git a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlValueExtractor.java b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlValueExtractor.java index eea8b450dad15..b68548a12a14b 100644 --- a/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlValueExtractor.java +++ b/bundles/org.openhab.binding.smartmeter/src/main/java/org/openhab/binding/smartmeter/internal/sml/SmlValueExtractor.java @@ -41,7 +41,7 @@ public final class SmlValueExtractor { /** * Constructor * - * @param obis + * @param listEntry */ public SmlValueExtractor(SmlListEntry listEntry) { smlListEntry = listEntry; diff --git a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsBindingConstants.java b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsBindingConstants.java index 87b5e5b34a390..22af3b7b7335a 100644 --- a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsBindingConstants.java +++ b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SmartthingsBinding} class defines common constants, which are + * The {@link SmartthingsBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Bob Raker - Initial contribution diff --git a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHandlerFactory.java b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHandlerFactory.java index 02c0fbefdc3d3..ccd9e4f4ec208 100644 --- a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHandlerFactory.java +++ b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHandlerFactory.java @@ -118,7 +118,6 @@ public SmartthingsHandlerFactory() { * * @param path http path which tells Smartthings what to execute * @param data data to send - * @return Response from Smartthings * @throws InterruptedException * @throws TimeoutException * @throws ExecutionException diff --git a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHubCommand.java b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHubCommand.java index 62baec5867e4f..753e26716c625 100644 --- a/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHubCommand.java +++ b/bundles/org.openhab.binding.smartthings/src/main/java/org/openhab/binding/smartthings/internal/SmartthingsHubCommand.java @@ -31,7 +31,6 @@ public interface SmartthingsHubCommand { * * @param path http path which tells Smartthings what to execute * @param data data to send - * @return Response from Smartthings * @throws InterruptedException * @throws TimeoutException * @throws ExecutionException diff --git a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/connector/WebInterface.java b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/connector/WebInterface.java index b9fff4b80bc3a..e862ed915dc55 100644 --- a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/connector/WebInterface.java +++ b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/connector/WebInterface.java @@ -244,7 +244,9 @@ private void executeCommand() { /** * Constructor to set up interface * - * @param config Bridge configuration + * @param scheduler + * @param handler + * @param httpClient */ public WebInterface(ScheduledExecutorService scheduler, SolarEdgeHandler handler, HttpClient httpClient) { this.config = handler.getConfiguration(); diff --git a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/handler/SolarEdgeHandler.java b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/handler/SolarEdgeHandler.java index 0834b72467ec7..9177176e29cf5 100644 --- a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/handler/SolarEdgeHandler.java +++ b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/handler/SolarEdgeHandler.java @@ -32,8 +32,9 @@ @NonNullByDefault public interface SolarEdgeHandler extends ThingHandler, ChannelProvider { /** - * Called from {@link WebInterface#authenticate()} to update - * the thing status because updateStatus is protected. + * Called from + * {@link org.openhab.binding.solaredge.internal.connector.WebInterface.WebRequestExecutor#authenticate()} + * to update the thing status because updateStatus is protected. * * @param status Bridge status * @param statusDetail Bridge status detail diff --git a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/model/AbstractDataResponseTransformer.java b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/model/AbstractDataResponseTransformer.java index 2763357ecefe4..3d2410baf1423 100644 --- a/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/model/AbstractDataResponseTransformer.java +++ b/bundles/org.openhab.binding.solaredge/src/main/java/org/openhab/binding/solaredge/internal/model/AbstractDataResponseTransformer.java @@ -126,7 +126,7 @@ private final > void putQuantityType(Map t * @param targetMap result will be put into this map * @param channel channel to assign the value * @param value the value to convert - * @param unit as string + * @param unitAsString unit as string */ protected final void putPowerType(Map targetMap, @Nullable Channel channel, @Nullable Double value, @Nullable String unitAsString) { @@ -143,7 +143,7 @@ protected final void putPowerType(Map targetMap, @Nullable Chann * @param targetMap result will be put into this map * @param channel channel to assign the value * @param value the value to convert - * @param unit as string + * @param unitAsString as string */ protected final void putEnergyType(Map targetMap, @Nullable Channel channel, @Nullable Double value, @Nullable String unitAsString) { diff --git a/bundles/org.openhab.binding.solarlog/src/main/java/org/openhab/binding/solarlog/internal/SolarLogBindingConstants.java b/bundles/org.openhab.binding.solarlog/src/main/java/org/openhab/binding/solarlog/internal/SolarLogBindingConstants.java index 79092b6b6c93e..f416e7a03426d 100644 --- a/bundles/org.openhab.binding.solarlog/src/main/java/org/openhab/binding/solarlog/internal/SolarLogBindingConstants.java +++ b/bundles/org.openhab.binding.solarlog/src/main/java/org/openhab/binding/solarlog/internal/SolarLogBindingConstants.java @@ -15,7 +15,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SolarLogBinding} class defines common constants, which are + * The {@link SolarLogBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Johann Richard - Initial contribution diff --git a/bundles/org.openhab.binding.solarmax/src/main/java/org/openhab/binding/solarmax/internal/connector/SolarMaxConnector.java b/bundles/org.openhab.binding.solarmax/src/main/java/org/openhab/binding/solarmax/internal/connector/SolarMaxConnector.java index be2c51b234039..8f05c3e41baf6 100644 --- a/bundles/org.openhab.binding.solarmax/src/main/java/org/openhab/binding/solarmax/internal/connector/SolarMaxConnector.java +++ b/bundles/org.openhab.binding.solarmax/src/main/java/org/openhab/binding/solarmax/internal/connector/SolarMaxConnector.java @@ -62,9 +62,8 @@ public class SolarMaxConnector { * * @param host hostname or ip address of the SolarMax device to be contacted * @param portNumber portNumber the SolarMax is listening on (default is 12345) - * @param commandList a list of commands to be sent to the SolarMax device + * @param deviceAddress * @return - * @throws UnknownHostException if the host is unknown * @throws SolarMaxException if some other exception occurs */ public static SolarMaxData getAllValuesFromSolarMax(final String host, final int portNumber, diff --git a/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/EnergyManagerCollection.java b/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/EnergyManagerCollection.java index 0f8bb9f00cb9a..1124d98a66f85 100644 --- a/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/EnergyManagerCollection.java +++ b/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/EnergyManagerCollection.java @@ -25,7 +25,8 @@ /** * Collection of all devices known to the energy manager including the energy manager itself. * - * The {@link Device}s are generated from the {@link DeviceDTO}s inside of the {@link EnergyManagerDTO} + * The {@link Device}s are generated from the {@link org.openhab.binding.solarwatt.internal.domain.dto.DeviceDTO}s + * inside of the {@link org.openhab.binding.solarwatt.internal.domain.dto.EnergyManagerDTO} * * @author Sven Carstens - Initial contribution */ diff --git a/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/SolarwattChannel.java b/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/SolarwattChannel.java index fa62adc0d2b9f..b31f6e94e18ac 100644 --- a/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/SolarwattChannel.java +++ b/bundles/org.openhab.binding.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/SolarwattChannel.java @@ -20,7 +20,7 @@ /** * Aggregation of the interesting parts to write into a channel. * - * From this the {@link ChannelType}s are created. + * From this the {@link org.openhab.core.thing.type.ChannelType}s are created. * * @author Sven Carstens - Initial contribution */ diff --git a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosBindingConstants.java b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosBindingConstants.java index 226042eb1670d..4ef3615db5111 100644 --- a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosBindingConstants.java +++ b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosBindingConstants.java @@ -19,7 +19,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SonosBinding} class defines common constants, which are + * The {@link SonosBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosXMLParser.java b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosXMLParser.java index a1716a8d848cf..fa5a660c37af3 100644 --- a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosXMLParser.java +++ b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/SonosXMLParser.java @@ -86,8 +86,6 @@ private enum CurrentElement { /** * @param xml * @return a list of alarms from the given xml string. - * @throws IOException - * @throws SAXException */ public static List getAlarmsFromStringResult(String xml) { AlarmHandler handler = new AlarmHandler(); @@ -106,8 +104,6 @@ public static List getAlarmsFromStringResult(String xml) { /** * @param xml * @return a list of Entries from the given xml string. - * @throws IOException - * @throws SAXException */ public static List getEntriesFromString(String xml) { EntryHandler handler = new EntryHandler(); @@ -130,7 +126,6 @@ public static List getEntriesFromString(String xml) { * * @param xml * @return The value of the desc xml tag - * @throws SAXException */ public static @Nullable SonosResourceMetaData getResourceMetaData(String xml) throws SAXException { XMLReader reader = XMLReaderFactory.createXMLReader(); @@ -148,11 +143,8 @@ public static List getEntriesFromString(String xml) { } /** - * @param controller * @param xml * @return zone group from the given xml - * @throws IOException - * @throws SAXException */ public static List getZoneGroupFromXML(String xml) { ZoneGroupHandler handler = new ZoneGroupHandler(); diff --git a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/handler/ZonePlayerHandler.java b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/handler/ZonePlayerHandler.java index c4d2532764dd3..d360e00f254c4 100644 --- a/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/handler/ZonePlayerHandler.java +++ b/bundles/org.openhab.binding.sonos/src/main/java/org/openhab/binding/sonos/internal/handler/ZonePlayerHandler.java @@ -1676,8 +1676,6 @@ private Long getResultEntry(Map resultInput, String requestedKey /** * Save the state (track, position etc) of the Sonos Zone player. - * - * @return true if no error occurred. */ protected void saveState() { synchronized (stateLock) { @@ -1763,8 +1761,6 @@ protected void saveState() { /** * Restore the state (track, position etc) of the Sonos Zone player. - * - * @return true if no error occurred. */ protected void restoreState() { synchronized (stateLock) { @@ -2218,7 +2214,7 @@ public void removeAllTracksFromQueue() { /** * Play music from the line-in of the given Player referenced by the given UDN or name * - * @param udn or name + * @param command udn or name */ public void playLineIn(Command command) { if (command instanceof StringType) { @@ -2565,7 +2561,7 @@ public boolean publicAddress(LineInType lineInType) { /** * Play a given url to music in one of the music libraries. * - * @param url + * @param command * in the format of //host/folder/filename.mp3 */ public void playURI(Command command) { @@ -2618,7 +2614,7 @@ private void scheduleNotificationSound(final Command command) { /** * Play a given notification sound * - * @param url in the format of //host/folder/filename.mp3 + * @param notificationURL in the format of //host/folder/filename.mp3 */ public void playNotificationSoundURI(Command notificationURL) { if (notificationURL instanceof StringType) { @@ -3118,8 +3114,7 @@ public void playTuneinStation(Command command) { * This will attempt to match the station string with an entry in the * favorites list, this supports both single entries and playlists * - * @param favorite to match - * @return true if a match was found and played. + * @param command favorite to match */ public void playFavorite(Command command) { if (command instanceof StringType) { diff --git a/bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/SonyProjectorConnector.java b/bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/SonyProjectorConnector.java index e3d29ed73642c..ccce85b9d743e 100644 --- a/bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/SonyProjectorConnector.java +++ b/bundles/org.openhab.binding.sonyprojector/src/main/java/org/openhab/binding/sonyprojector/internal/communication/SonyProjectorConnector.java @@ -1102,7 +1102,7 @@ protected void writeCommand(byte[] message) throws CommunicationException { * Validate the content of a returned message * * @param responseMessage the buffer containing the returned message - * @param the projector setting to get or set + * @param item the projector setting to get or set * * @throws CommunicationException if the message has unexpected content */ diff --git a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/SoulissBindingConstants.java b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/SoulissBindingConstants.java index 2b25c409cac88..d9ae374b51002 100644 --- a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/SoulissBindingConstants.java +++ b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/SoulissBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SoulissBinding} class defines common constants, which are + * The {@link SoulissBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Tonino Fazio - Initial contribution diff --git a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/discovery/SoulissGatewayDiscovery.java b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/discovery/SoulissGatewayDiscovery.java index 0c40fbe39765f..a3e70c8663e36 100644 --- a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/discovery/SoulissGatewayDiscovery.java +++ b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/discovery/SoulissGatewayDiscovery.java @@ -34,8 +34,8 @@ import org.slf4j.LoggerFactory; /** - * The {@link soulissHandlerFactory} is responsible for creating things and thingGeneric - * handlers. + * The {@link org.openhab.binding.souliss.internal.SoulissHandlerFactory} is responsible for creating + * things and thingGeneric handlers. * * @author Tonino Fazio - Initial contribution * @author Luca Calcaterra - Refactor for OH3 diff --git a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericActionMessage.java b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericActionMessage.java index bbda3f014fd36..78094020b0744 100644 --- a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericActionMessage.java +++ b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericActionMessage.java @@ -70,7 +70,7 @@ public String getTopicNumber() { } /** - * @param the Topic Variant + * @return the Topic Variant */ public String getTopicVariant() { return sTopicVariant; diff --git a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericHandler.java b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericHandler.java index df4d94a3258fa..27d29f6e6d3b0 100644 --- a/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericHandler.java +++ b/bundles/org.openhab.binding.souliss/src/main/java/org/openhab/binding/souliss/internal/handler/SoulissGenericHandler.java @@ -93,8 +93,7 @@ public void initialize() { } /** - * @param SoulissNode - * the SoulissNodeID to get + * @return the SoulissNodeID */ public int getNode() { return iNode; diff --git a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/actions/SpotifyActions.java b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/actions/SpotifyActions.java index fa89c9d765aa0..6d7623d89d3e0 100644 --- a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/actions/SpotifyActions.java +++ b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/actions/SpotifyActions.java @@ -37,7 +37,6 @@ public class SpotifyActions implements ThingActions, ThingHandlerService { * Play a context uri (track or other) on the current active device (if null is passed for deviceID) or the given * device at the given offset and/or position in milliseconds. * - * @param actions Spotify Actions object. * @param contextUri context uri (track or other) * @param deviceId Id of the device to play on, or current device if given null * @param offset Offset in the list, default 0. diff --git a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyApi.java b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyApi.java index f3f18f8f496cb..297ca2d87a513 100644 --- a/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyApi.java +++ b/bundles/org.openhab.binding.spotify/src/main/java/org/openhab/binding/spotify/internal/api/SpotifyApi.java @@ -80,8 +80,9 @@ public class SpotifyApi { /** * Constructor. * - * @param authorizer The authorizer used to refresh the access token when expired - * @param connector The Spotify connector handling the Web Api calls to Spotify + * @param oAuthClientService The authorizer used to refresh the access token when expired + * @param scheduler + * @param httpClient The Spotify connector handling the Web Api calls to Spotify */ public SpotifyApi(OAuthClientService oAuthClientService, ScheduledExecutorService scheduler, HttpClient httpClient) { diff --git a/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/SqueezeBoxBindingConstants.java b/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/SqueezeBoxBindingConstants.java index f1b5e6bddb840..3dc986a12a194 100644 --- a/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/SqueezeBoxBindingConstants.java +++ b/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/SqueezeBoxBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SqueezeBoxBinding} class defines common constants, which are used + * The {@link SqueezeBoxBindingConstants} class defines common constants, which are used * across the whole binding. * * @author Dan Cunningham - Initial contribution diff --git a/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/handler/SqueezeBoxServerHandler.java b/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/handler/SqueezeBoxServerHandler.java index 72cf92376903b..c4487ffe2f53d 100644 --- a/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/handler/SqueezeBoxServerHandler.java +++ b/bundles/org.openhab.binding.squeezebox/src/main/java/org/openhab/binding/squeezebox/internal/handler/SqueezeBoxServerHandler.java @@ -305,7 +305,7 @@ public void sleep(String mac, Duration sleepDuration) { /** * Send a generic command to a given player * - * @param playerId + * @param mac * @param command */ public void playerCommand(String mac, String command) { diff --git a/bundles/org.openhab.binding.surepetcare/src/main/java/org/openhab/binding/surepetcare/internal/utils/SurePetcareDeviceCurfewListTypeAdapterFactory.java b/bundles/org.openhab.binding.surepetcare/src/main/java/org/openhab/binding/surepetcare/internal/utils/SurePetcareDeviceCurfewListTypeAdapterFactory.java index 4b600715256ea..22bdf67bc9f1d 100644 --- a/bundles/org.openhab.binding.surepetcare/src/main/java/org/openhab/binding/surepetcare/internal/utils/SurePetcareDeviceCurfewListTypeAdapterFactory.java +++ b/bundles/org.openhab.binding.surepetcare/src/main/java/org/openhab/binding/surepetcare/internal/utils/SurePetcareDeviceCurfewListTypeAdapterFactory.java @@ -30,8 +30,9 @@ import com.google.gson.stream.MalformedJsonException; /** - * The {@link GsonColonDateTypeAdapter} class is a custom TypeAdapter factory to ensure deserialization always returns a - * list even if the Json document contains only a single curfew object and not an array. + * The {@link SurePetcareDeviceCurfewListTypeAdapterFactory} class is a custom TypeAdapter factory to ensure + * deserialization always returns a list even if the Json document contains only a single curfew object and + * not an array. * * See https://stackoverflow.com/questions/43412261/make-gson-accept-single-objects-where-it-expects-arrays * diff --git a/bundles/org.openhab.binding.synopanalyzer/src/main/java/org/openhab/binding/synopanalyzer/internal/SynopAnalyzerBindingConstants.java b/bundles/org.openhab.binding.synopanalyzer/src/main/java/org/openhab/binding/synopanalyzer/internal/SynopAnalyzerBindingConstants.java index bd6eb67b43b92..abd8fd796c22b 100644 --- a/bundles/org.openhab.binding.synopanalyzer/src/main/java/org/openhab/binding/synopanalyzer/internal/SynopAnalyzerBindingConstants.java +++ b/bundles/org.openhab.binding.synopanalyzer/src/main/java/org/openhab/binding/synopanalyzer/internal/SynopAnalyzerBindingConstants.java @@ -25,7 +25,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link SynopAnalyzerBinding} class defines common constants used across the whole binding. + * The {@link SynopAnalyzerBindingConstants} class defines common constants used across the whole binding. * * @author Gaël L'hopital - Initial contribution */ diff --git a/bundles/org.openhab.binding.systeminfo/src/main/java/org/openhab/binding/systeminfo/internal/SysteminfoThingTypeProvider.java b/bundles/org.openhab.binding.systeminfo/src/main/java/org/openhab/binding/systeminfo/internal/SysteminfoThingTypeProvider.java index 03cd6d20a7b49..fa1382468385c 100644 --- a/bundles/org.openhab.binding.systeminfo/src/main/java/org/openhab/binding/systeminfo/internal/SysteminfoThingTypeProvider.java +++ b/bundles/org.openhab.binding.systeminfo/src/main/java/org/openhab/binding/systeminfo/internal/SysteminfoThingTypeProvider.java @@ -50,7 +50,8 @@ import org.slf4j.LoggerFactory; /** - * Extended channels can be auto discovered and added to newly created groups in the {@link SysteminfoHandler}. The + * Extended channels can be auto discovered and added to newly created groups in the + * {@link org.openhab.binding.systeminfo.internal.handler.SysteminfoHandler}. The * thing needs to be updated to add the groups. The `SysteminfoThingTypeProvider` OSGi service gives access to the * `ThingTypeRegistry` and serves the updated `ThingType`. * diff --git a/bundles/org.openhab.binding.tado/src/main/java/org/openhab/binding/tado/internal/TadoBindingConstants.java b/bundles/org.openhab.binding.tado/src/main/java/org/openhab/binding/tado/internal/TadoBindingConstants.java index 2607a289e2411..283554cbd3f2c 100644 --- a/bundles/org.openhab.binding.tado/src/main/java/org/openhab/binding/tado/internal/TadoBindingConstants.java +++ b/bundles/org.openhab.binding.tado/src/main/java/org/openhab/binding/tado/internal/TadoBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link TadoBinding} class defines common constants, which are + * The {@link TadoBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Dennis Frommknecht - Initial contribution diff --git a/bundles/org.openhab.binding.tankerkoenig/src/main/java/org/openhab/binding/tankerkoenig/internal/TankerkoenigBindingConstants.java b/bundles/org.openhab.binding.tankerkoenig/src/main/java/org/openhab/binding/tankerkoenig/internal/TankerkoenigBindingConstants.java index e8ef99a1069c6..82f6f84ed0d32 100644 --- a/bundles/org.openhab.binding.tankerkoenig/src/main/java/org/openhab/binding/tankerkoenig/internal/TankerkoenigBindingConstants.java +++ b/bundles/org.openhab.binding.tankerkoenig/src/main/java/org/openhab/binding/tankerkoenig/internal/TankerkoenigBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link TankerkoenigBinding} class defines common constants, which are + * The {@link TankerkoenigBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Dennis Dollinger - Initial contribution diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoControlHandlerFactory.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoControlHandlerFactory.java index 5d0b2086e4222..0d99fa473172c 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoControlHandlerFactory.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoControlHandlerFactory.java @@ -43,7 +43,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link TapoControlHandler} is responsible for handling commands, which are + * The {@link ThingHandler} is responsible for handling commands, which are * sent to one of the channels. * * @author Christian Wild - Initial contribution diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoDiscoveryService.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoDiscoveryService.java index 5a2381423b2de..feba4e0edeed9 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoDiscoveryService.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/TapoDiscoveryService.java @@ -56,8 +56,6 @@ public class TapoDiscoveryService extends AbstractDiscoveryService implements Th /** * INIT CLASS - * - * @param bridgeHandler */ public TapoDiscoveryService() { super(SUPPORTED_THING_TYPES_UIDS, TAPO_DISCOVERY_TIMEOUT_S, false); diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java index 7bd5af66773db..5e89c7f63e355 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceConnector.java @@ -58,7 +58,8 @@ public class TapoDeviceConnector extends TapoDeviceHttpApi { /** * INIT CLASS * - * @param config TapoControlConfiguration class + * @param device + * @param bridgeThingHandler */ public TapoDeviceConnector(TapoDevice device, TapoBridgeHandler bridgeThingHandler) { super(device, bridgeThingHandler); @@ -111,7 +112,7 @@ public boolean login() { /** * send custom command to device * - * @param plBuilder Payloadbuilder with unencrypted payload + * @param queryMethod query method */ public void sendCustomQuery(String queryMethod) { /* create payload */ @@ -390,7 +391,7 @@ protected void handleCustomResponse(String responseBody) { /** * handle error * - * @param te TapoErrorHandler + * @param tapoError TapoErrorHandler */ @Override protected void handleError(TapoErrorHandler tapoError) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceHttpApi.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceHttpApi.java index e1c06b3af797b..5c1698bea282b 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceHttpApi.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/api/TapoDeviceHttpApi.java @@ -66,7 +66,8 @@ public class TapoDeviceHttpApi { /** * INIT CLASS * - * @param config TapoControlConfiguration class + * @param device + * @param bridgeThingHandler */ public TapoDeviceHttpApi(TapoDevice device, TapoBridgeHandler bridgeThingHandler) { this.bridge = bridgeThingHandler; @@ -125,7 +126,7 @@ protected void handleChildDevices(String responseBody) { /** * handle error * - * @param te TapoErrorHandler + * @param tapoError TapoErrorHandler */ protected void handleError(TapoErrorHandler tapoError) { } @@ -563,7 +564,7 @@ public Boolean loggedIn(Boolean raiseError) { /** * Set new ipAddress * - * @param new ipAdress + * @param ipAddress new ipAdress */ public void setDeviceURL(String ipAddress) { this.ipAddress = ipAddress; @@ -584,7 +585,6 @@ public void setDeviceURL(String ipAddress, String token) { /** * Set new token * - * @param deviceURL * @param token */ protected void setToken(String token) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java index 50d42e1d17247..0b9768c4f2c4d 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoDevice.java @@ -376,7 +376,7 @@ public void setEnergyData(TapoEnergyData energyData) { /** * Set Device Child data to device * - * @param energyData + * @param hostData */ public void setChildData(TapoChildData hostData) { hostData.getChildDeviceList().forEach(child -> { @@ -399,7 +399,7 @@ public void responsePasstrough(String responseBody) { * If only one property must be changed, there is also a convenient method * updateProperty(String name, String value). * - * @param TapoDeviceInfo + * @param deviceInfo */ protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) { /* device properties */ diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoLightStrip.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoLightStrip.java index f453cd87cb168..93a3f59d339df 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoLightStrip.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoLightStrip.java @@ -200,7 +200,7 @@ protected void setLightEffects(TapoLightEffect lightEffect) { /** * UPDATE PROPERTIES * - * @param TapoDeviceInfo + * @param deviceInfo TapoDeviceInfo */ @Override protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartBulb.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartBulb.java index fc76768ac3080..6094b99492606 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartBulb.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartBulb.java @@ -171,7 +171,7 @@ protected void setLightEffect(String fxName) { /** * UPDATE PROPERTIES * - * @param TapoDeviceInfo + * @param deviceInfo TapoDeviceInfo */ @Override protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartPlug.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartPlug.java index 1202bb7d4ed1b..55860df7b4fa4 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartPlug.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoSmartPlug.java @@ -81,7 +81,7 @@ public void handleCommand(ChannelUID channelUID, Command command) { /** * UPDATE PROPERTIES * - * @param TapoDeviceInfo + * @param deviceInfo TapoDeviceInfo */ @Override protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoUniversalDevice.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoUniversalDevice.java index 20b80f78b47c6..ec0867e940d6c 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoUniversalDevice.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/device/TapoUniversalDevice.java @@ -182,7 +182,7 @@ public void responsePasstrough(String responseBody) { /** * UPDATE PROPERTIES * - * @param TapoDeviceInfo + * @param deviceInfo TapoDeviceInfo */ @Override protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCipher.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCipher.java index 84374d65af14e..1404a6d673501 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCipher.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCipher.java @@ -58,7 +58,6 @@ public TapoCipher() { * * @param handshakeKey Key from Handshake-Request * @param credentials TapoCredentials - * @throws Exception */ public TapoCipher(String handshakeKey, TapoCredentials credentials) { setKey(handshakeKey, credentials); diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCredentials.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCredentials.java index b2471e3594619..9ea8f43df7985 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCredentials.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoCredentials.java @@ -52,8 +52,8 @@ public TapoCredentials() { /** * INIT CLASS * - * @param email E-Mail-adress of Tapo Cloud - * @param passowrd Password of Tapo Cloud + * @param eMail E-Mail-adress of Tapo Cloud + * @param password Password of Tapo Cloud */ public TapoCredentials(String eMail, String password) { this.mimeEncoder = new MimeEncode(); @@ -63,8 +63,8 @@ public TapoCredentials(String eMail, String password) { /** * set credentials. * - * @param username username (eMail-adress) of Tapo Cloud - * @param passowrd Password of Tapo Cloud + * @param eMail username (eMail-adress) of Tapo Cloud + * @param password Password of Tapo Cloud */ public void setCredectials(String eMail, String password) { try { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoErrorHandler.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoErrorHandler.java index 7efa99280ba3d..d8fa4b28cefa5 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoErrorHandler.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoErrorHandler.java @@ -62,7 +62,7 @@ public TapoErrorHandler(Integer errorCode, String infoMessage) { /** * Constructor * - * @param exception Exception + * @param ex Exception */ public TapoErrorHandler(Exception ex) { raiseError(ex); @@ -71,7 +71,7 @@ public TapoErrorHandler(Exception ex) { /** * Constructor * - * @param exception Exception + * @param ex Exception * @param infoMessage optional info-message */ public TapoErrorHandler(Exception ex, String infoMessage) { @@ -142,7 +142,7 @@ public void raiseError(Integer errorCode, String infoMessage) { /** * Raises new error * - * @param exception Exception + * @param ex Exception */ public void raiseError(Exception ex) { raiseError(ex, ""); @@ -151,7 +151,7 @@ public void raiseError(Exception ex) { /** * Raises new error * - * @param exception Exception + * @param ex Exception * @param infoMessage optional info-message */ public void raiseError(Exception ex, String infoMessage) { diff --git a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java index 83cd3f86e1d25..1300a2080dd61 100644 --- a/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java +++ b/bundles/org.openhab.binding.tapocontrol/src/main/java/org/openhab/binding/tapocontrol/internal/helpers/TapoUtils.java @@ -269,7 +269,7 @@ public static OnOffType getOnOffType(@Nullable Boolean boolVal) { /** * Return OnOffType from bool * - * @param boolVal + * @param intVal */ public static OnOffType getOnOffType(Integer intVal) { return intVal == 0 ? OnOffType.OFF : OnOffType.ON; diff --git a/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/TeleinfoInputStream.java b/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/TeleinfoInputStream.java index 3b917653b964e..1b5fec503fc58 100644 --- a/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/TeleinfoInputStream.java +++ b/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/TeleinfoInputStream.java @@ -87,10 +87,8 @@ public void close() throws IOException { * Returns the next frame. * * @return the next frame or null if end of stream - * @throws TimeoutException * @throws IOException * @throws InvalidFrameException - * @throws Exception */ public synchronized @Nullable Frame readNextFrame() throws InvalidFrameException, IOException { // seek the next header frame diff --git a/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/serialport/FrameUtil.java b/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/serialport/FrameUtil.java index fef6aec08b842..b5c7adf46194d 100644 --- a/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/serialport/FrameUtil.java +++ b/bundles/org.openhab.binding.teleinfo/src/main/java/org/openhab/binding/teleinfo/internal/reader/io/serialport/FrameUtil.java @@ -16,7 +16,8 @@ import org.openhab.binding.teleinfo.internal.serial.TeleinfoTicMode; /** - * The {@link FrameUtil} class defines a utility class for {@link FrameCbetmLong}. + * The {@link FrameUtil} class defines a utility class for + * {@link org.openhab.binding.teleinfo.internal.data.FrameType#CBETM_LONG_BASE}. * * @author Nicolas SIBERIL - Initial contribution */ diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/TellstickBindingConstants.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/TellstickBindingConstants.java index 4c78d97a86953..51b383e22f838 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/TellstickBindingConstants.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/TellstickBindingConstants.java @@ -33,7 +33,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link TellstickBinding} class defines common constants, which are + * The {@link TellstickBindingConstants} class defines common constants, which are * used across the whole binding. * * @author jarlebh - Initial contribution diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLiveConfiguration.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLiveConfiguration.java index 7aa4d50798610..6c985c88c134d 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLiveConfiguration.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLiveConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.tellstick.internal.conf; /** - * Configuration class for {@link TellstickBridge} bridge used to connect to the + * Configuration class for Tellstick bridge used to connect to the * Telldus Live service. * * @author Jarle Hjortland - Initial contribution diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLocalConfiguration.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLocalConfiguration.java index ae79fa498d71e..422900213408f 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLocalConfiguration.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TelldusLocalConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.tellstick.internal.conf; /** - * Configuration class for {@link TellstickBridge} bridge used to connect to the + * Configuration class for Tellstick bridge used to connect to the * Telldus local API. * * @author Jan Gustafsson - Initial contribution diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TellstickBridgeConfiguration.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TellstickBridgeConfiguration.java index 8de0a75bc13b9..a9c2af5067957 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TellstickBridgeConfiguration.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/conf/TellstickBridgeConfiguration.java @@ -13,7 +13,7 @@ package org.openhab.binding.tellstick.internal.conf; /** - * Configuration class for {@link TellstickBridge} bridge used to connect to the + * Configuration class for Tellstick bridge used to connect to the * Telldus Core service on the local machine. * * @author Jarle Hjortland - Initial contribution diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/DeviceStatusListener.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/DeviceStatusListener.java index b004c530185fc..f55aa97e3ee22 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/DeviceStatusListener.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/DeviceStatusListener.java @@ -26,7 +26,8 @@ public interface DeviceStatusListener { /** * This method is called whenever the state of the given device has changed. - * The new state can be obtained by {@link FullLight#getState()}. + * The new state can be obtained by {@link TellstickNetDevice#getState()} / + * {@link TellstickLocalDeviceDTO#getState()}. * * @param bridge * The Tellstick bridge the changed device is connected to. diff --git a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/TelldusBridgeHandler.java b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/TelldusBridgeHandler.java index 893decacb9fb7..94fa3989f7f77 100644 --- a/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/TelldusBridgeHandler.java +++ b/bundles/org.openhab.binding.tellstick/src/main/java/org/openhab/binding/tellstick/internal/handler/TelldusBridgeHandler.java @@ -51,7 +51,7 @@ public interface TelldusBridgeHandler { /** * Get a sensor from the bridgehandler. * - * @param serialNumber + * @param deviceUUId * @return */ Device getSensor(String deviceUUId); diff --git a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/TiVoBindingConstants.java b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/TiVoBindingConstants.java index c78c0f3e5d8f6..afe0a67fa6c30 100644 --- a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/TiVoBindingConstants.java +++ b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/TiVoBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link TiVoBinding} class defines common constants that are + * The {@link TiVoBindingConstants} class defines common constants that are * used across the whole binding. * * @author Jayson Kubilis (DigitalBytes) - Initial contribution diff --git a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/handler/TiVoHandler.java b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/handler/TiVoHandler.java index 5abfb938fc0cd..36a242078a3ee 100644 --- a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/handler/TiVoHandler.java +++ b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/handler/TiVoHandler.java @@ -307,7 +307,8 @@ private TivoStatusData chChannelChange(String commandKeyword, String command) th /** * {@link updateTivoStatus} populates the items with the status / channel information. * - * @param tivoStatusData the {@link TivoStatusData} + * @param oldStatusData the {@link TivoStatusData} + * @param newStatusData the {@link TivoStatusData} */ public void updateTivoStatus(TivoStatusData oldStatusData, TivoStatusData newStatusData) { if (newStatusData.getConnectionStatus() != ConnectionStatus.INIT) { diff --git a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoConfigData.java b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoConfigData.java index 1019077ccda54..a43af837dce4c 100644 --- a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoConfigData.java +++ b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoConfigData.java @@ -16,8 +16,8 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The Class {@link TivoConfigData} stores the dynamic configuration parameters used within the {@link TivoHandler } and - * {@link TivoConfigStatusProvider}. + * The Class {@link TivoConfigData} stores the dynamic configuration parameters used within the {@link TiVoHandler} and + * {@link TivoStatusProvider}. * * @author Jayson Kubilis (DigitalBytes) - Initial contribution * @author Andrew Black (AndyXMB) - minor updates, removal of unused DiscoveryService functionality. diff --git a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusData.java b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusData.java index ea38df75a1c10..d6ef681a77e53 100644 --- a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusData.java +++ b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusData.java @@ -101,7 +101,7 @@ public String toString() { } /** - * {@link isCmdOK} indicates if the last command executed correctly. + * {@link #isCmdOK()} indicates if the last command executed correctly. * * @return cmdOk boolean true = executed correctly, false = last command failed with error message */ diff --git a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusProvider.java b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusProvider.java index 51581a9c8f989..c2f54b1814b75 100644 --- a/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusProvider.java +++ b/bundles/org.openhab.binding.tivo/src/main/java/org/openhab/binding/tivo/internal/service/TivoStatusProvider.java @@ -60,7 +60,6 @@ public class TivoStatusProvider { * Instantiates a new TivoConfigStatusProvider. * * @param tivoConfigData {@link TivoConfigData} configuration data for the specific thing. - * @param tivoStatusData {@link TivoStatusData} status data for the specific thing. * @param tivoHandler {@link TivoHandler} parent handler object for the TivoConfigStatusProvider. * */ @@ -73,11 +72,10 @@ public TivoStatusProvider(TivoConfigData tivoConfigData, TiVoHandler tivoHandler } /** - * {@link statusRefresh} initiates a connection to the TiVo. When a new connection is made and the TiVo is online, - * the current channel is always returned. The connection is then closed (allows the socket to be used by other - * devices). + * {@link #statusRefresh()} initiates a connection to the TiVo. When a new connection is made and the TiVo is + * online, the current channel is always returned. The connection is then closed (allows the socket to be used + * by other devices). * - * @return {@link TivoStatusData} object * @throws InterruptedException */ public void statusRefresh() throws InterruptedException { diff --git a/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/TouchWandUnitStatusUpdateListener.java b/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/TouchWandUnitStatusUpdateListener.java index d16bf964db24e..3ffc58e9dffe3 100644 --- a/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/TouchWandUnitStatusUpdateListener.java +++ b/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/TouchWandUnitStatusUpdateListener.java @@ -16,8 +16,8 @@ import org.openhab.binding.touchwand.internal.dto.TouchWandUnitData; /** - * Interface for a listener on the {@link TouchWandWebSocket}. - * When it is registered on the socket, it gets called back when {@link TouchWandWebSocket} receives data. + * Interface for a listener on the {@link TouchWandWebSockets}. + * When it is registered on the socket, it gets called back when {@link TouchWandWebSockets} receives data. * * @author Roie Geron - Initial contribution */ diff --git a/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/config/TouchwandBridgeConfiguration.java b/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/config/TouchwandBridgeConfiguration.java index 670ae0c2c1e03..813ca6357064d 100644 --- a/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/config/TouchwandBridgeConfiguration.java +++ b/bundles/org.openhab.binding.touchwand/src/main/java/org/openhab/binding/touchwand/internal/config/TouchwandBridgeConfiguration.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * Configuration class for {@link TouchwandBridgeHandler}. + * Configuration class for {@link TouchWandBridgeHandler}. * * @author Roie Geron - Initial contribution */ diff --git a/bundles/org.openhab.binding.tradfri/src/main/java/org/openhab/binding/tradfri/internal/TradfriColor.java b/bundles/org.openhab.binding.tradfri/src/main/java/org/openhab/binding/tradfri/internal/TradfriColor.java index a03caa0b9845f..de44616ada643 100644 --- a/bundles/org.openhab.binding.tradfri/src/main/java/org/openhab/binding/tradfri/internal/TradfriColor.java +++ b/bundles/org.openhab.binding.tradfri/src/main/java/org/openhab/binding/tradfri/internal/TradfriColor.java @@ -19,7 +19,7 @@ /** * The {@link TradfriColor} is used for conversion between color formats. - * Use the static methods {@link TradfriColor#fromCie(int, int, int)} and {@link TradfriColor#fromHSBType(HSBType)} for + * Use the static constructors {@link #TradfriColor(int, int, int)} and {@link #TradfriColor(HSBType)} for * construction. * * @author Holger Reichert - Initial contribution diff --git a/bundles/org.openhab.binding.twitter/src/main/java/org/openhab/binding/twitter/internal/action/TwitterActions.java b/bundles/org.openhab.binding.twitter/src/main/java/org/openhab/binding/twitter/internal/action/TwitterActions.java index a1390f27f4a16..12a56c3574161 100644 --- a/bundles/org.openhab.binding.twitter/src/main/java/org/openhab/binding/twitter/internal/action/TwitterActions.java +++ b/bundles/org.openhab.binding.twitter/src/main/java/org/openhab/binding/twitter/internal/action/TwitterActions.java @@ -25,7 +25,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link TweetActions} class defines rule actions for sending tweet + * The {@link TwitterActions} class defines rule actions for sending tweet * * @author Scott Hanson - Initial contribution */ diff --git a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/UniFiPoePortThingConfig.java b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/UniFiPoePortThingConfig.java index df5467892164a..536707e82a200 100644 --- a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/UniFiPoePortThingConfig.java +++ b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/UniFiPoePortThingConfig.java @@ -15,8 +15,8 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link UniFiPoeThingConfig} encapsulates all the configuration options for an instance of the - * {@link UniFiPoePortThingHandler}. + * The {@link UniFiPoePortThingConfig} encapsulates all the configuration options for an instance of the + * {@link org.openhab.binding.unifi.internal.handler.UniFiPoePortThingHandler}. * * @author Hilbrand Bouwkamp - Initial contribution */ diff --git a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/dto/UnfiPortOverrideJsonObject.java b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/dto/UnfiPortOverrideJsonObject.java index c19f45e9262a4..14ebad5d8872d 100644 --- a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/dto/UnfiPortOverrideJsonObject.java +++ b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/api/dto/UnfiPortOverrideJsonObject.java @@ -15,7 +15,7 @@ import com.google.gson.JsonObject; /** - * The {@link UnfiPortOverride} represents the data model of UniFi port override. + * The {@link UnfiPortOverrideJsonObject} represents the data model of UniFi port override. * Using plain JsonObject to make sure any data in the object is not lost when writing the data back to the UniFi * device. * diff --git a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/ssl/UniFiTrustManager.java b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/ssl/UniFiTrustManager.java index ea95057585aa9..d6c70dad7eedc 100644 --- a/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/ssl/UniFiTrustManager.java +++ b/bundles/org.openhab.binding.unifi/src/main/java/org/openhab/binding/unifi/internal/ssl/UniFiTrustManager.java @@ -26,7 +26,7 @@ * * The {@link UniFiTrustManager} is a "trust all" implementation of {@link X509ExtendedTrustManager}. * - * @see {@link UniFiTrustManagerProvider} + * @see UniFiTrustManagerProvider * * @author Matthew Bowman - Initial contribution */ diff --git a/bundles/org.openhab.binding.unifiedremote/src/main/java/org/openhab/binding/unifiedremote/internal/UnifiedRemoteDiscoveryService.java b/bundles/org.openhab.binding.unifiedremote/src/main/java/org/openhab/binding/unifiedremote/internal/UnifiedRemoteDiscoveryService.java index 6415fe5665905..47cb27bb5daff 100644 --- a/bundles/org.openhab.binding.unifiedremote/src/main/java/org/openhab/binding/unifiedremote/internal/UnifiedRemoteDiscoveryService.java +++ b/bundles/org.openhab.binding.unifiedremote/src/main/java/org/openhab/binding/unifiedremote/internal/UnifiedRemoteDiscoveryService.java @@ -126,11 +126,10 @@ private ServerInfo tryParseServerDiscovery(DatagramPacket receivePacket) throws /** * Send broadcast packets with service request string until a response - * is received. Return the response as String (even though it should - * contain an internet address). + * is received. * - * @return String received from server. Should be server IP address. - * Returns empty string if failed to get valid reply. + * @param listener Listener to process the String received from server. Should be server IP address. + * */ public void sendBroadcast(Consumer listener) { byte[] receiveBuffer = new byte[MAX_PACKET_SIZE]; diff --git a/bundles/org.openhab.binding.urtsi/src/main/java/org/openhab/binding/urtsi/internal/UrtsiBindingConstants.java b/bundles/org.openhab.binding.urtsi/src/main/java/org/openhab/binding/urtsi/internal/UrtsiBindingConstants.java index 09a9ec8393cda..b7a4202a43191 100644 --- a/bundles/org.openhab.binding.urtsi/src/main/java/org/openhab/binding/urtsi/internal/UrtsiBindingConstants.java +++ b/bundles/org.openhab.binding.urtsi/src/main/java/org/openhab/binding/urtsi/internal/UrtsiBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link UrtsiBinding} class defines common constants, which are + * The {@link UrtsiBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Oliver Libutzki - Initial contribution diff --git a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClient.java b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClient.java index 69b714d5d98ca..6c34e0993da2e 100644 --- a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClient.java +++ b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClient.java @@ -127,8 +127,6 @@ public interface SVDRPClient { * Retrieve VDR Version from SVDRP Client * * @return VDR Version - * @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible - * @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response */ String getSVDRPVersion(); } diff --git a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClientImpl.java b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClientImpl.java index 5941a666c4dc9..51b776193ec88 100644 --- a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClientImpl.java +++ b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPClientImpl.java @@ -64,7 +64,7 @@ public SVDRPClientImpl(String host, int port, String charset) { * * Open VDR Socket Connection * - * @throws IOException if an IO Error occurs + * @throws SVDRPConnectionException if an IO Error occurs */ @Override public void openConnection() throws SVDRPConnectionException, SVDRPParseResponseException { @@ -117,7 +117,7 @@ public void openConnection() throws SVDRPConnectionException, SVDRPParseResponse /** * Close VDR Socket Connection * - * @throws IOException if an IO Error occurs + * @throws SVDRPConnectionException if an IO Error occurs */ @Override public void closeConnection() throws SVDRPConnectionException, SVDRPParseResponseException { @@ -403,7 +403,6 @@ public boolean isRecordingActive() throws SVDRPConnectionException, SVDRPParseRe * Retrieve VDR Version from SVDRP Client * * @return VDR Version - * @throws SVDRPException thrown if something's not OK with SVDRP call */ @Override public String getSVDRPVersion() { diff --git a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPTimerList.java b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPTimerList.java index fc510b582121a..3e647a0f4515b 100644 --- a/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPTimerList.java +++ b/bundles/org.openhab.binding.vdr/src/main/java/org/openhab/binding/vdr/internal/svdrp/SVDRPTimerList.java @@ -33,7 +33,6 @@ public class SVDRPTimerList { * * @param message SVDRP Client Response * @return Timer List Object - * @throws SVDRPParseResponseException thrown if response data is not parseable */ public static SVDRPTimerList parse(String message) { SVDRPTimerList timers = new SVDRPTimerList(); diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCgetHouseStatus.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCgetHouseStatus.java index 2c03a3ad92a1f..039a934de94c5 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCgetHouseStatus.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCgetHouseStatus.java @@ -38,10 +38,8 @@ *

    * Methods in addition to the mentioned interface: *

      - *
    • {@link #getNtfNodeID} to retrieve the node identifier which has been changed.
    • - *
    • {@link #getNtfState} to retrieve the state of the node which has been changed.
    • - *
    • {@link #getNtfCurrentPosition} to retrieve the actual position of this node.
    • - *
    • {@link #getNtfTarget} to retrieve the target position of this node.
    • + *
    • {@link #getProduct} to retrieve product type.
    • + *
    • {@link #setCreatorCommand} to set the command id that identifies the API on which 'product' will be created.
    • *
    *

    * NOTE: the class does NOT define a request as it only works as receiver. diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCrunProductCommand.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCrunProductCommand.java index ef63483a16f31..52fcbbcaa469e 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCrunProductCommand.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/bridge/slip/SCrunProductCommand.java @@ -44,7 +44,7 @@ *

    * Methods in addition to the mentioned interface: *

      - *
    • {@link #setNodeAndMainParameter} to define the node and intended parameter value.
    • + *
    • {@link #setNodeIdAndParameters} to define the node and intended parameter value.
    • *
    * * @see RunProductCommand diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxExistingProducts.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxExistingProducts.java index bb1cedc2f8438..a5702df929234 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxExistingProducts.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxExistingProducts.java @@ -126,7 +126,6 @@ public boolean register(VeluxProduct newProduct) { * method may ignore the new product if it was created by certain originating commands, or if the new product has * certain actuator states. * - * @param requestingCommand the command that requested the data from the hub and so triggered calling this method. * @param newProduct the product containing new data. * * @return true if the product exists in the database. diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java index e885112aced50..bd43eaf64aeaa 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProduct.java @@ -495,11 +495,13 @@ public int getTimeStamp() { /** * Returns the display position of the actuator. + *
      *
    • As a general rule it returns currentPosition, except as follows.. *
    • If the actuator is in a motion state it returns targetPosition *
    • If the motion state is 'done' but the currentPosition is invalid it returns targetPosition *
    • If the manual override flag is set it returns the unknown position value - * + *
    + * * @return The display position of the actuator */ public int getDisplayPosition() { diff --git a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductVelocity.java b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductVelocity.java index 7e40a1a0eca5c..a93858b97d8d0 100644 --- a/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductVelocity.java +++ b/bundles/org.openhab.binding.velux/src/main/java/org/openhab/binding/velux/internal/things/VeluxProductVelocity.java @@ -30,7 +30,7 @@ * Methods in handle this type of information: *
      *
    • {@link #getVelocity()} to retrieve the value of the characteristic.
    • - *
    • {@link #get(int)} to convert a value into the characteristic.
    • + *
    • {@link #get(short)} to convert a value into the characteristic.
    • *
    • {@link #getByName(String)} to convert a name into the characteristic.
    • *
    • {@link #dump} to retrieve a human-readable description of all values.
    • *
    diff --git a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/VenstarThermostatBindingConstants.java b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/VenstarThermostatBindingConstants.java index ca0773cb77b29..43567ec450cad 100644 --- a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/VenstarThermostatBindingConstants.java +++ b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/VenstarThermostatBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link VenstarThermostatBinding} class defines common constants, which are + * The {@link VenstarThermostatBindingConstants} class defines common constants, which are * used across the whole binding. * * @author William Welliver - Initial contribution diff --git a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntime.java b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntime.java index 3b3c344202211..b423756f8a978 100644 --- a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntime.java +++ b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntime.java @@ -15,7 +15,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link VenstarRunTime} represents one Runtime from the RuntimeData returned from the REST API + * The {@link VenstarRuntime} represents one Runtime from the RuntimeData returned from the REST API * * @author Matthew Davies - Initial contribution */ diff --git a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntimeData.java b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntimeData.java index a029ad5e769df..f0b31ee2e4c9c 100644 --- a/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntimeData.java +++ b/bundles/org.openhab.binding.venstarthermostat/src/main/java/org/openhab/binding/venstarthermostat/internal/dto/VenstarRuntimeData.java @@ -17,7 +17,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; /** - * The {@link VenstarRunTimeData} represents the list of runtimes returned from the REST API. + * The {@link VenstarRuntimeData} represents the list of runtimes returned from the REST API. * * @author Matthew Davies - Initial contribution */ diff --git a/bundles/org.openhab.binding.verisure/src/main/java/org/openhab/binding/verisure/internal/VerisureBindingConstants.java b/bundles/org.openhab.binding.verisure/src/main/java/org/openhab/binding/verisure/internal/VerisureBindingConstants.java index 41f8024d747f7..1519ae22b31f2 100644 --- a/bundles/org.openhab.binding.verisure/src/main/java/org/openhab/binding/verisure/internal/VerisureBindingConstants.java +++ b/bundles/org.openhab.binding.verisure/src/main/java/org/openhab/binding/verisure/internal/VerisureBindingConstants.java @@ -16,7 +16,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link VerisureBinding} class defines common constants, which are + * The {@link VerisureBindingConstants} class defines common constants, which are * used across the whole binding. * * @author l3rum - Initial contribution diff --git a/bundles/org.openhab.binding.vesync/src/main/java/org/openhab/binding/vesync/internal/handlers/VeSyncBaseDeviceHandler.java b/bundles/org.openhab.binding.vesync/src/main/java/org/openhab/binding/vesync/internal/handlers/VeSyncBaseDeviceHandler.java index 53073b579c1c1..bd7311ae312b5 100644 --- a/bundles/org.openhab.binding.vesync/src/main/java/org/openhab/binding/vesync/internal/handlers/VeSyncBaseDeviceHandler.java +++ b/bundles/org.openhab.binding.vesync/src/main/java/org/openhab/binding/vesync/internal/handlers/VeSyncBaseDeviceHandler.java @@ -270,7 +270,6 @@ public String getValidatedIdString() { BridgeHandler bridgeHandler = getBridgeHandler(); if (bridgeHandler instanceof VeSyncBridgeHandler vesyncBridgeHandler) { - final String configMac = config.macId; // Try to use the mac directly diff --git a/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/VitotronicBindingConstants.java b/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/VitotronicBindingConstants.java index 6569776d3eaf2..38ec3b331f66f 100644 --- a/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/VitotronicBindingConstants.java +++ b/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/VitotronicBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link VitotronicBinding} class defines common constants, which are + * The {@link VitotronicBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Stefan Andres - Initial contribution diff --git a/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/handler/VitotronicThingHandler.java b/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/handler/VitotronicThingHandler.java index ded88051d3724..2f8947f88466c 100644 --- a/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/handler/VitotronicThingHandler.java +++ b/bundles/org.openhab.binding.vitotronic/src/main/java/org/openhab/binding/vitotronic/internal/handler/VitotronicThingHandler.java @@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory; /** - * The {@link VitotronicHandler} is responsible for handling commands, which are + * The {@link VitotronicThingHandler} is responsible for handling commands, which are * sent to one of the channels. * * @author Stefan Andres - Initial contribution diff --git a/bundles/org.openhab.binding.vizio/src/main/java/org/openhab/binding/vizio/internal/communication/VizioCommunicator.java b/bundles/org.openhab.binding.vizio/src/main/java/org/openhab/binding/vizio/internal/communication/VizioCommunicator.java index 632aa573ed9b4..2a9bac3eeca16 100644 --- a/bundles/org.openhab.binding.vizio/src/main/java/org/openhab/binding/vizio/internal/communication/VizioCommunicator.java +++ b/bundles/org.openhab.binding.vizio/src/main/java/org/openhab/binding/vizio/internal/communication/VizioCommunicator.java @@ -109,7 +109,7 @@ public Audio getCurrentAudioSettings() throws VizioException { /** * Change the volume of the Vizio TV * - * @param the command JSON for the desired volue + * @param commandJSON the command JSON for the desired volue * @return A PutResponse response object * @throws VizioException * @@ -132,7 +132,7 @@ public CurrentInput getCurrentInput() throws VizioException { /** * Change the currently selected input of the Vizio TV * - * @param the command JSON for the selected input + * @param commandJSON the command JSON for the selected input * @return A PutResponse response object * @throws VizioException * @@ -166,7 +166,7 @@ public CurrentApp getCurrentApp() throws VizioException { /** * Launch a given streaming app on the Vizio TV * - * @param the VizioAppConfig data for the app to launch + * @param appConfig the VizioAppConfig data for the app to launch * @return A PutResponse response object * @throws VizioException * @@ -178,7 +178,7 @@ public PutResponse launchApp(VizioAppConfig appConfig) throws VizioException { /** * Send a key press command to the Vizio TV * - * @param the command JSON for the key press + * @param commandJSON the command JSON for the key press * @return A PutResponse response object * @throws VizioException * @@ -190,8 +190,8 @@ public PutResponse sendKeyPress(String commandJSON) throws VizioException { /** * Start the pairing process to obtain an auth token from the TV * - * @param the deviceName that is displayed in the TV settings after the device is registered - * @param the deviceId a unique number that identifies this pairing request + * @param deviceName the deviceName that is displayed in the TV settings after the device is registered + * @param deviceId the deviceId a unique number that identifies this pairing request * @return A PairingStart response object * @throws VizioException * @@ -206,9 +206,9 @@ public PairingStart startPairing(String deviceName, int deviceId) throws VizioEx /** * Finish the pairing process by submitting the code that was displayed on the TV to obtain the auth token * - * @param the same deviceId that was used by startPairing() - * @param the pairingCode that was displayed on the TV - * @param the pairingToken returned by startPairing() + * @param deviceId the same deviceId that was used by startPairing() + * @param pairingCode the pairingCode that was displayed on the TV + * @param pairingToken the pairingToken returned by startPairing() * @return A PairingComplete response object * @throws VizioException * diff --git a/bundles/org.openhab.binding.weathercompany/src/main/java/org/openhab/binding/weathercompany/internal/handler/WeatherCompanyForecastHandler.java b/bundles/org.openhab.binding.weathercompany/src/main/java/org/openhab/binding/weathercompany/internal/handler/WeatherCompanyForecastHandler.java index 977ec416cf008..cc1b7cae9e42a 100644 --- a/bundles/org.openhab.binding.weathercompany/src/main/java/org/openhab/binding/weathercompany/internal/handler/WeatherCompanyForecastHandler.java +++ b/bundles/org.openhab.binding.weathercompany/src/main/java/org/openhab/binding/weathercompany/internal/handler/WeatherCompanyForecastHandler.java @@ -335,7 +335,7 @@ private void updateDaily(int day, String channelId, State state) { private void updateDaypart(int daypartIndex, String dayOrNight, String channelId, State state) { int day = daypartIndex / 2; - String dON = dayOrNight.equals("D") ? CH_GROUP_FORECAST_DAYPART_DAY : CH_GROUP_FORECAST_DAYPART_NIGHT; + String dON = "D".equals(dayOrNight) ? CH_GROUP_FORECAST_DAYPART_DAY : CH_GROUP_FORECAST_DAYPART_NIGHT; updateChannel(CH_GROUP_FORECAST_DAY + String.valueOf(day) + dON + "#" + channelId, state); } diff --git a/bundles/org.openhab.binding.weatherunderground/src/main/java/org/openhab/binding/weatherunderground/internal/WeatherUndergroundBindingConstants.java b/bundles/org.openhab.binding.weatherunderground/src/main/java/org/openhab/binding/weatherunderground/internal/WeatherUndergroundBindingConstants.java index cf43a9cb12828..b08df4fb5018c 100644 --- a/bundles/org.openhab.binding.weatherunderground/src/main/java/org/openhab/binding/weatherunderground/internal/WeatherUndergroundBindingConstants.java +++ b/bundles/org.openhab.binding.weatherunderground/src/main/java/org/openhab/binding/weatherunderground/internal/WeatherUndergroundBindingConstants.java @@ -20,7 +20,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link WeatherUndergroundBinding} class defines common constants, which are + * The {@link WeatherUndergroundBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Laurent Garnier - Initial contribution diff --git a/bundles/org.openhab.binding.wemo/src/main/java/org/openhab/binding/wemo/internal/WemoBindingConstants.java b/bundles/org.openhab.binding.wemo/src/main/java/org/openhab/binding/wemo/internal/WemoBindingConstants.java index 241ab2c81081c..c74f7e7981d5b 100644 --- a/bundles/org.openhab.binding.wemo/src/main/java/org/openhab/binding/wemo/internal/WemoBindingConstants.java +++ b/bundles/org.openhab.binding.wemo/src/main/java/org/openhab/binding/wemo/internal/WemoBindingConstants.java @@ -18,7 +18,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link WemoBinding} class defines common constants, which are + * The {@link WemoBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Hans-Jörg Merk - Initial contribution diff --git a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/api/WolfSmartsetApi.java b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/api/WolfSmartsetApi.java index 2fc890fc38db1..3c98821df7a08 100644 --- a/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/api/WolfSmartsetApi.java +++ b/bundles/org.openhab.binding.wolfsmartset/src/main/java/org/openhab/binding/wolfsmartset/internal/api/WolfSmartsetApi.java @@ -62,7 +62,7 @@ import com.google.gson.JsonSyntaxException; /** - * The {@link WolfSmartsetCloudConnector} class is used for connecting to the Wolf Smartset cloud service + * The {@link WolfSmartsetApi} class is used for connecting to the Wolf Smartset cloud service * * @author Bo Biene - Initial contribution */ diff --git a/bundles/org.openhab.binding.xmppclient/src/main/java/org/openhab/binding/xmppclient/internal/handler/PublishTriggerChannel.java b/bundles/org.openhab.binding.xmppclient/src/main/java/org/openhab/binding/xmppclient/internal/handler/PublishTriggerChannel.java index bc73a2f87eedb..9fe2b00e2fe83 100644 --- a/bundles/org.openhab.binding.xmppclient/src/main/java/org/openhab/binding/xmppclient/internal/handler/PublishTriggerChannel.java +++ b/bundles/org.openhab.binding.xmppclient/src/main/java/org/openhab/binding/xmppclient/internal/handler/PublishTriggerChannel.java @@ -16,8 +16,9 @@ import org.openhab.core.thing.ChannelUID; /** - * Subscribes to a chat and calls {@link AbstractBrokerHandler#triggerChannel(ChannelUID, String)} if a value has been - * received. + * Subscribes to a chat and calls + * {@link org.openhab.binding.xmppclient.internal.handler.XMPPClientHandler#triggerChannel(ChannelUID, String)} if a + * value has been received. * * @author Pavel Gololobov - Initial contribution */ diff --git a/bundles/org.openhab.binding.yamahamusiccast/src/main/java/org/openhab/binding/yamahamusiccast/internal/YamahaMusiccastHandlerFactory.java b/bundles/org.openhab.binding.yamahamusiccast/src/main/java/org/openhab/binding/yamahamusiccast/internal/YamahaMusiccastHandlerFactory.java index 7d9c598544322..66f8ada981735 100644 --- a/bundles/org.openhab.binding.yamahamusiccast/src/main/java/org/openhab/binding/yamahamusiccast/internal/YamahaMusiccastHandlerFactory.java +++ b/bundles/org.openhab.binding.yamahamusiccast/src/main/java/org/openhab/binding/yamahamusiccast/internal/YamahaMusiccastHandlerFactory.java @@ -29,7 +29,7 @@ import org.osgi.service.component.annotations.Reference; /** - * The {@link YamahamusiccastHandlerFactory} is responsible for creating things and thing + * The {@link YamahaMusiccastHandlerFactory} is responsible for creating things and thing * handlers. * * @author Lennert Coopman - Initial contribution diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPlayControl.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPlayControl.java index 12f47719b84e3..e06f3de752adf 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPlayControl.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPlayControl.java @@ -37,49 +37,56 @@ public interface InputWithPlayControl extends IStateUpdatable { * Start the playback of the content which is usually selected by the means of the Navigation control class or * which has been stopped by stop(). * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void play() throws IOException, ReceivedMessageParseException; /** * Stop the currently playing content. Use start() to start again. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void stop() throws IOException, ReceivedMessageParseException; /** * Pause the currently playing content. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void pause() throws IOException, ReceivedMessageParseException; /** * Skip forward. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void skipFF() throws IOException, ReceivedMessageParseException; /** * Skip reverse. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void skipREV() throws IOException, ReceivedMessageParseException; /** * Next track. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void nextTrack() throws IOException, ReceivedMessageParseException; /** * Previous track. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void previousTrack() throws IOException, ReceivedMessageParseException; } diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPresetControl.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPresetControl.java index faccc7809153f..246b1381d0a25 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPresetControl.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithPresetControl.java @@ -40,7 +40,8 @@ public interface InputWithPresetControl extends IStateUpdatable { * Select a preset channel. * * @param presetChannel The preset position [1,40] - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException; } diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithTunerBandControl.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithTunerBandControl.java index 711d2f5b438b2..895b0af99ce3c 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithTunerBandControl.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithTunerBandControl.java @@ -34,7 +34,8 @@ public interface InputWithTunerBandControl extends IStateUpdatable { * Select a DAB band by name. * * @param band The band name (e.g. FM or DAB) - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ void selectBandByName(String band) throws IOException, ReceivedMessageParseException; } diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java index c383ec6b2326b..01a75959368d2 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java @@ -88,7 +88,8 @@ private void navigateCursor(String command) throws IOException, ReceivedMessageP /** * Navigate back * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void goBack() throws IOException, ReceivedMessageParseException { @@ -98,7 +99,8 @@ public void goBack() throws IOException, ReceivedMessageParseException { /** * Navigate up * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void goUp() throws IOException, ReceivedMessageParseException { @@ -108,7 +110,8 @@ public void goUp() throws IOException, ReceivedMessageParseException { /** * Navigate down * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void goDown() throws IOException, ReceivedMessageParseException { @@ -118,7 +121,8 @@ public void goDown() throws IOException, ReceivedMessageParseException { /** * Navigate left. Not for all zones or functions available. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void goLeft() throws IOException, ReceivedMessageParseException { @@ -128,7 +132,8 @@ public void goLeft() throws IOException, ReceivedMessageParseException { /** * Navigate right. Not for all zones or functions available. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void goRight() throws IOException, ReceivedMessageParseException { @@ -138,7 +143,8 @@ public void goRight() throws IOException, ReceivedMessageParseException { /** * Select current item. Not for all zones or functions available. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void selectCurrentItem() throws IOException, ReceivedMessageParseException { @@ -148,7 +154,8 @@ public void selectCurrentItem() throws IOException, ReceivedMessageParseExceptio /** * Navigate to root menu * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public boolean goToRoot() throws IOException, ReceivedMessageParseException { @@ -270,7 +277,8 @@ private boolean selectItem(String name) throws IOException, ReceivedMessageParse * some time because it retries the request for up to MENU_MAX_WAITING_TIME or the menu state reports * "Ready", whatever comes first. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void update() throws IOException, ReceivedMessageParseException { diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java index 25b1fe4410935..c3e3665b7aa4f 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java @@ -102,7 +102,8 @@ protected void applyModelVariations() { * Start the playback of the content which is usually selected by the means of the Navigation control class or * which has been stopped by stop(). * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void play() throws IOException, ReceivedMessageParseException { @@ -112,7 +113,8 @@ public void play() throws IOException, ReceivedMessageParseException { /** * Stop the currently playing content. Use start() to start again. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void stop() throws IOException, ReceivedMessageParseException { @@ -122,7 +124,8 @@ public void stop() throws IOException, ReceivedMessageParseException { /** * Pause the currently playing content. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void pause() throws IOException, ReceivedMessageParseException { @@ -132,7 +135,8 @@ public void pause() throws IOException, ReceivedMessageParseException { /** * Skip forward. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void skipFF() throws IOException, ReceivedMessageParseException { @@ -146,7 +150,8 @@ public void skipFF() throws IOException, ReceivedMessageParseException { /** * Skip reverse. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void skipREV() throws IOException, ReceivedMessageParseException { @@ -160,7 +165,8 @@ public void skipREV() throws IOException, ReceivedMessageParseException { /** * Next track. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void nextTrack() throws IOException, ReceivedMessageParseException { @@ -170,7 +176,8 @@ public void nextTrack() throws IOException, ReceivedMessageParseException { /** * Previous track. This is not available for streaming content like on NET_RADIO. * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void previousTrack() throws IOException, ReceivedMessageParseException { @@ -192,7 +199,8 @@ private void sendCommand(String command) throws IOException, ReceivedMessagePars /** * Updates the playback information * - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void update() throws IOException, ReceivedMessageParseException { diff --git a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java index 04305656f093f..2fd79777c8b04 100644 --- a/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java +++ b/bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java @@ -86,8 +86,9 @@ protected void applyModelVariations() { /** * Updates the preset information - * - * @throws Exception + * + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void update() throws IOException, ReceivedMessageParseException { @@ -168,7 +169,8 @@ private int convertToPresetNumber(String presetValue) { * Select a preset channel. * * @param presetChannel The preset position [1,40] - * @throws Exception + * @throws IOException + * @throws ReceivedMessageParseException */ @Override public void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException { diff --git a/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/ZWayBindingConstants.java b/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/ZWayBindingConstants.java index d9aa2606aa884..91ab3de07326f 100644 --- a/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/ZWayBindingConstants.java +++ b/bundles/org.openhab.binding.zway/src/main/java/org/openhab/binding/zway/internal/ZWayBindingConstants.java @@ -21,7 +21,7 @@ import org.openhab.core.thing.ThingTypeUID; /** - * The {@link ZWayBinding} class defines common constants, which are + * The {@link ZWayBindingConstants} class defines common constants, which are * used across the whole binding. * * @author Patrick Hecker - Initial contribution diff --git a/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/AbstractHomekitAccessoryImpl.java b/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/AbstractHomekitAccessoryImpl.java index 4d06fc923edae..f3caaaf1bfcfb 100644 --- a/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/AbstractHomekitAccessoryImpl.java +++ b/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/AbstractHomekitAccessoryImpl.java @@ -332,7 +332,6 @@ protected void addCharacteristic(HomekitTaggedItem item, Characteristic characte * If the primary service does not yet exist, it won't be added to it. It's the resposibility * of the caller to add characteristics when the primary service is created. * - * @param type * @param characteristic */ @NonNullByDefault diff --git a/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitCharacteristicFactory.java b/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitCharacteristicFactory.java index 5f617408cf22c..ab61a87fbbe1b 100644 --- a/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitCharacteristicFactory.java +++ b/bundles/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/accessories/HomekitCharacteristicFactory.java @@ -346,7 +346,7 @@ public static & CharacteristicEnum> Map createMapp * Takes item state as value and retrieves the key for that value from mapping. * E.g. used to map StringItem value to HomeKit Enum * - * @param characteristicType characteristicType to identify item + * @param item item * @param mapping mapping * @param defaultValue default value if nothing found in mapping * @param type of the result derived from diff --git a/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/RuleUtils.java b/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/RuleUtils.java index 78018cf1d05c4..4a1f3256ede3a 100644 --- a/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/RuleUtils.java +++ b/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/RuleUtils.java @@ -268,8 +268,8 @@ private static Trigger createAbsoluteDateTimeFromTimeString(String localtime) { *
  • Every weekday given by bbb at given left side time, randomized by right side time. Right side time has to be * smaller than 12 hours *
  • - *
      * Timers + *
        *
      • PT[hh]:[mm]:[ss] Timer, expiring after given time *
      • PT[hh]:[mm]:[ss] Timer, expiring after given time *
      • PT[hh]:[mm]:[ss]A[hh]:[mm]:[ss] Timer with random element diff --git a/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/dto/HueUserAuth.java b/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/dto/HueUserAuth.java index 28d41f839d8c4..93a64e31314e7 100644 --- a/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/dto/HueUserAuth.java +++ b/bundles/org.openhab.io.hueemulation/src/main/java/org/openhab/io/hueemulation/internal/dto/HueUserAuth.java @@ -39,7 +39,8 @@ public class HueUserAuth { /** * Create a new user * - * @param apikey The hue "username" + * @param appName + * @param deviceName */ public HueUserAuth(String appName, String deviceName) { this.name = appName + "#" + deviceName; diff --git a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/NeeoBrainServlet.java b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/NeeoBrainServlet.java index 6a24b4d7b9966..877913e00eb7e 100644 --- a/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/NeeoBrainServlet.java +++ b/bundles/org.openhab.io.neeo/src/main/java/org/openhab/io/neeo/internal/NeeoBrainServlet.java @@ -26,7 +26,7 @@ /** * This implementation of {@link AbstractServlet} will handle any requests from the NEEO Brain. The brain will ask for * any search results (performed by {@link NeeoBrainSearchService}) and requests state values, set - * state values (performed by {@Link NeeoBrainService}) + * state values (performed by {@link NeeoBrainService}) * * @author Tim Roberts - Initial Contribution */ diff --git a/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/DynamoDBPersistenceService.java b/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/DynamoDBPersistenceService.java index dd8355acf0708..9de6557c5b3f2 100644 --- a/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/DynamoDBPersistenceService.java +++ b/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/DynamoDBPersistenceService.java @@ -85,7 +85,7 @@ * * The service creates tables automatically, one for numbers, and one for strings. * - * @see AbstractDynamoDBItem.fromState for details how different items are persisted + * @see AbstractDynamoDBItem#fromStateNew for details how different items are persisted * * @author Sami Salonen - Initial contribution * @author Kai Kreuzer - Migration to 3.x diff --git a/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/PageOfInterestSubscriber.java b/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/PageOfInterestSubscriber.java index 11073d88bff45..44ac8b27b2de2 100644 --- a/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/PageOfInterestSubscriber.java +++ b/bundles/org.openhab.persistence.dynamodb/src/main/java/org/openhab/persistence/dynamodb/internal/PageOfInterestSubscriber.java @@ -41,7 +41,7 @@ public class PageOfInterestSubscriber implements Subscriber { /** * Create new PageOfInterestSubscriber * - * @param subscriber subscriber to get the page of interest + * @param future subscriber to get the page of interest * @param pageIndex page index that we want subscribe * @param pageSize page size */ diff --git a/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/DynamoDBTableNameResolverTest.java b/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/DynamoDBTableNameResolverTest.java index d6ff9dc9b9e00..394b45e0f778b 100644 --- a/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/DynamoDBTableNameResolverTest.java +++ b/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/DynamoDBTableNameResolverTest.java @@ -100,7 +100,6 @@ public void testResolveLegacyTablesPresent() throws InterruptedException { criteria.setItemName(item.getName()); try { - // Old tables do not exit --> resolves to new schema assertEquals(ExpectedTableSchema.NEW, resolveMaybeLegacy(legacyService, executor)); diff --git a/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/TestStoreMixedTypesTest.java b/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/TestStoreMixedTypesTest.java index 3262127f3d3d9..13a0e10ac02d0 100644 --- a/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/TestStoreMixedTypesTest.java +++ b/bundles/org.openhab.persistence.dynamodb/src/test/java/org/openhab/persistence/dynamodb/internal/TestStoreMixedTypesTest.java @@ -65,7 +65,6 @@ public void tearDownLocalItems() { @SuppressWarnings("null") public void storeItemWithDifferentTypes() { - try { // First writing two values with string item { diff --git a/bundles/org.openhab.persistence.influxdb/src/main/java/org/openhab/persistence/influxdb/internal/InfluxDBRepository.java b/bundles/org.openhab.persistence.influxdb/src/main/java/org/openhab/persistence/influxdb/internal/InfluxDBRepository.java index f73b151490702..c1e7d74a7b4de 100644 --- a/bundles/org.openhab.persistence.influxdb/src/main/java/org/openhab/persistence/influxdb/internal/InfluxDBRepository.java +++ b/bundles/org.openhab.persistence.influxdb/src/main/java/org/openhab/persistence/influxdb/internal/InfluxDBRepository.java @@ -72,7 +72,7 @@ public interface InfluxDBRepository { * Write points to database * * @param influxPoints {@link List} to write - * @returns true if points have been written, false otherwise + * @return true if points have been written, false otherwise */ boolean write(List influxPoints); diff --git a/bundles/org.openhab.transform.jsonpath/src/main/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationService.java b/bundles/org.openhab.transform.jsonpath/src/main/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationService.java index a54896a506c84..364448d70fc06 100644 --- a/bundles/org.openhab.transform.jsonpath/src/main/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationService.java +++ b/bundles/org.openhab.transform.jsonpath/src/main/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationService.java @@ -46,7 +46,7 @@ public class JSonPathTransformationService implements TransformationService { /** * Transforms the input source by JSonPath expression. * - * @param function JsonPath expression + * @param jsonPathExpression JsonPath expression * @param source String which contains JSON * @throws TransformationException If the JsonPath expression is invalid, an {@link InvalidPathException} is thrown, * which is encapsulated in a {@link TransformationException}. diff --git a/bundles/org.openhab.transform.jsonpath/src/test/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationServiceTest.java b/bundles/org.openhab.transform.jsonpath/src/test/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationServiceTest.java index 9c63e40ab466a..4ca30c6361591 100644 --- a/bundles/org.openhab.transform.jsonpath/src/test/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationServiceTest.java +++ b/bundles/org.openhab.transform.jsonpath/src/test/java/org/openhab/transform/jsonpath/internal/JSonPathTransformationServiceTest.java @@ -19,7 +19,7 @@ import org.openhab.core.transform.TransformationException; /** - * @author Gaël L'hopital + * @author Gaël L'hopital - Initial contribution */ public class JSonPathTransformationServiceTest { diff --git a/bundles/org.openhab.transform.regex/src/main/java/org/openhab/transform/regex/internal/RegExTransformationService.java b/bundles/org.openhab.transform.regex/src/main/java/org/openhab/transform/regex/internal/RegExTransformationService.java index fc590ead74e49..f38c916bd7cc7 100644 --- a/bundles/org.openhab.transform.regex/src/main/java/org/openhab/transform/regex/internal/RegExTransformationService.java +++ b/bundles/org.openhab.transform.regex/src/main/java/org/openhab/transform/regex/internal/RegExTransformationService.java @@ -30,7 +30,7 @@ *

        * Note: the given Regular Expression must contain exactly one group! * - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ @NonNullByDefault @Component(property = { "openhab.transform=REGEX" }) diff --git a/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/AbstractTransformationServiceTest.java b/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/AbstractTransformationServiceTest.java index f1c9c82169649..5cdf73794183c 100644 --- a/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/AbstractTransformationServiceTest.java +++ b/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/AbstractTransformationServiceTest.java @@ -13,7 +13,7 @@ package org.openhab.transform.regex.internal; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public abstract class AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/RegExTransformationServiceTest.java b/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/RegExTransformationServiceTest.java index bcd137e2d4107..9e291a0261b50 100644 --- a/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/RegExTransformationServiceTest.java +++ b/bundles/org.openhab.transform.regex/src/test/java/org/openhab/transform/regex/internal/RegExTransformationServiceTest.java @@ -19,7 +19,7 @@ import org.openhab.core.transform.TransformationException; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public class RegExTransformationServiceTest extends AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.transform.scale/src/main/java/org/openhab/transform/scale/internal/ScaleTransformationService.java b/bundles/org.openhab.transform.scale/src/main/java/org/openhab/transform/scale/internal/ScaleTransformationService.java index 4ea3ae70ec89b..bfc2850813d8a 100644 --- a/bundles/org.openhab.transform.scale/src/main/java/org/openhab/transform/scale/internal/ScaleTransformationService.java +++ b/bundles/org.openhab.transform.scale/src/main/java/org/openhab/transform/scale/internal/ScaleTransformationService.java @@ -52,7 +52,7 @@ * The implementation of {@link TransformationService} which transforms the * input by matching it between limits of ranges in a scale file * - * @author Gaël L'hopital + * @author Gaël L'hopital - Initial contribution * @author Markus Rathgeb - drop usage of Guava */ @Component(service = { TransformationService.class, ConfigOptionProvider.class }, property = { diff --git a/bundles/org.openhab.transform.vat/src/main/java/org/openhab/transform/vat/internal/profile/VATTransformationProfile.java b/bundles/org.openhab.transform.vat/src/main/java/org/openhab/transform/vat/internal/profile/VATTransformationProfile.java index 73f26685f17b0..d95813227aec5 100644 --- a/bundles/org.openhab.transform.vat/src/main/java/org/openhab/transform/vat/internal/profile/VATTransformationProfile.java +++ b/bundles/org.openhab.transform.vat/src/main/java/org/openhab/transform/vat/internal/profile/VATTransformationProfile.java @@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory; /** - * Profile to offer the {@link VATTransformationService} on an ItemChannelLink. + * Profile to offer the {@link VATTransformationProfile} on an ItemChannelLink. * * @author Jacob Laursen - Initial contribution */ diff --git a/bundles/org.openhab.transform.xpath/src/main/java/org/openhab/transform/xpath/internal/XPathTransformationService.java b/bundles/org.openhab.transform.xpath/src/main/java/org/openhab/transform/xpath/internal/XPathTransformationService.java index 1f6894bf4323f..f9958bbf47a40 100644 --- a/bundles/org.openhab.transform.xpath/src/main/java/org/openhab/transform/xpath/internal/XPathTransformationService.java +++ b/bundles/org.openhab.transform.xpath/src/main/java/org/openhab/transform/xpath/internal/XPathTransformationService.java @@ -35,7 +35,7 @@ *

        * The implementation of {@link TransformationService} which transforms the input by XPath Expressions. * - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ @NonNullByDefault @Component(property = { "openhab.transform=XPATH" }) diff --git a/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/AbstractTransformationServiceTest.java b/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/AbstractTransformationServiceTest.java index 0ee067cee49a0..8c88c0843b000 100644 --- a/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/AbstractTransformationServiceTest.java +++ b/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/AbstractTransformationServiceTest.java @@ -13,7 +13,7 @@ package org.openhab.transform.xpath.internal; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public abstract class AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/XPathTransformationServiceTest.java b/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/XPathTransformationServiceTest.java index 5a80880926dfc..c801829591747 100644 --- a/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/XPathTransformationServiceTest.java +++ b/bundles/org.openhab.transform.xpath/src/test/java/org/openhab/transform/xpath/internal/XPathTransformationServiceTest.java @@ -19,7 +19,7 @@ import org.openhab.core.transform.TransformationException; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public class XPathTransformationServiceTest extends AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.transform.xslt/src/main/java/org/openhab/transform/xslt/internal/XsltTransformationService.java b/bundles/org.openhab.transform.xslt/src/main/java/org/openhab/transform/xslt/internal/XsltTransformationService.java index 99c446b544699..35dd8c2c421d6 100644 --- a/bundles/org.openhab.transform.xslt/src/main/java/org/openhab/transform/xslt/internal/XsltTransformationService.java +++ b/bundles/org.openhab.transform.xslt/src/main/java/org/openhab/transform/xslt/internal/XsltTransformationService.java @@ -35,7 +35,7 @@ *

        * The implementation of {@link TransformationService} which transforms the input by XSLT. * - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ @NonNullByDefault @Component(property = { "openhab.transform=XSLT" }) diff --git a/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/AbstractTransformationServiceTest.java b/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/AbstractTransformationServiceTest.java index d6bbe238d7d98..bec22f9948f09 100644 --- a/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/AbstractTransformationServiceTest.java +++ b/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/AbstractTransformationServiceTest.java @@ -13,7 +13,7 @@ package org.openhab.transform.xslt.internal; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public abstract class AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/XsltTransformationServiceTest.java b/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/XsltTransformationServiceTest.java index 647106a31fe01..d83d1074bb84f 100644 --- a/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/XsltTransformationServiceTest.java +++ b/bundles/org.openhab.transform.xslt/src/test/java/org/openhab/transform/xslt/internal/XsltTransformationServiceTest.java @@ -19,7 +19,7 @@ import org.openhab.core.transform.TransformationException; /** - * @author Thomas.Eichstaedt-Engelen + * @author Thomas.Eichstaedt-Engelen - Initial contribution */ public class XsltTransformationServiceTest extends AbstractTransformationServiceTest { diff --git a/bundles/org.openhab.voice.googletts/src/main/java/org/openhab/voice/googletts/internal/GoogleTTSVoice.java b/bundles/org.openhab.voice.googletts/src/main/java/org/openhab/voice/googletts/internal/GoogleTTSVoice.java index 337d589028a6b..32bb51018a8db 100644 --- a/bundles/org.openhab.voice.googletts/src/main/java/org/openhab/voice/googletts/internal/GoogleTTSVoice.java +++ b/bundles/org.openhab.voice.googletts/src/main/java/org/openhab/voice/googletts/internal/GoogleTTSVoice.java @@ -84,7 +84,7 @@ public String getLabel() { } /** - * @inheritDoc + * {@inheritDoc} */ @Override public Locale getLocale() { diff --git a/bundles/org.openhab.voice.mactts/src/main/java/org/openhab/voice/mactts/internal/MacTTSVoice.java b/bundles/org.openhab.voice.mactts/src/main/java/org/openhab/voice/mactts/internal/MacTTSVoice.java index 8719d51a3b482..3ab16d797d42b 100644 --- a/bundles/org.openhab.voice.mactts/src/main/java/org/openhab/voice/mactts/internal/MacTTSVoice.java +++ b/bundles/org.openhab.voice.mactts/src/main/java/org/openhab/voice/mactts/internal/MacTTSVoice.java @@ -86,7 +86,7 @@ public MacTTSVoice(String line) { int underscore = token.indexOf('_'); if (-1 == underscore) { // Check we're dealing with