From 09f071c14da157ebffd42ae3802f068274889b31 Mon Sep 17 00:00:00 2001 From: Wouter Born Date: Wed, 3 Jan 2024 00:54:15 +0100 Subject: [PATCH] Fix JavaDoc issues Fixes various issues including wrong parameter names, references, links and dangling JavaDocs. Signed-off-by: Wouter Born --- .../MarketplaceRuleTemplateProvider.java | 2 +- .../xml/AddonDiscoveryMethodConverter.java | 1 + .../internal/xml/AddonInfoXmlProvider.java | 3 ++- .../xml/AddonMatchPropertyConverter.java | 1 + .../internal/xml/AddonParameterConverter.java | 1 + .../audio/internal/javasound/AudioPlayer.java | 2 +- .../audio/internal/webaudio/PlayURLEvent.java | 3 ++- .../internal/OAuthClientServiceImpl.java | 4 +--- .../oauth2client/internal/OAuthConnector.java | 8 ++++--- .../internal/OAuthStoreHandlerTest.java | 2 +- .../provider/ScriptModuleTypeProvider.java | 2 +- .../core/automation/RulePredicates.java | 4 ++-- .../internal/RuleExecutionSimulator.java | 2 +- .../automation/internal/RuleRegistryImpl.java | 4 ++-- .../core/automation/internal/TriggerImpl.java | 2 +- .../commands/AbstractCommandProvider.java | 3 +-- .../CommandlineModuleTypeProvider.java | 4 +--- .../commands/CommandlineTemplateProvider.java | 2 -- .../automation/internal/commands/Printer.java | 7 +++---- .../CompositeModuleHandlerFactory.java | 3 +-- .../composite/CompositeTriggerHandler.java | 4 ++-- .../handler/ItemCommandActionHandler.java | 3 --- .../AbstractResourceBundleProvider.java | 7 ------- .../provider/HostFragmentMappingUtil.java | 4 +--- .../ModuleTypeResourceBundleProvider.java | 4 +--- .../provider/RuleResourceBundleImporter.java | 2 -- .../TemplateResourceBundleProvider.java | 21 ++++++++----------- .../automation/internal/provider/Vendor.java | 10 ++++----- .../provider/file/AutomationWatchService.java | 4 ++-- .../i18n/ModuleTypeI18nServiceImpl.java | 4 ++-- .../provider/i18n/ModuleTypeI18nUtil.java | 6 ++++-- .../ConfigDescriptionXmlProvider.java | 2 -- .../core/xml/util/XmlDocumentReader.java | 2 +- .../xml/util/XmlDocumentReaderTest.java | 4 ++-- .../discovery/addon/ip/IpAddonFinder.java | 2 +- .../upnp/tests/UpnpAddonFinderTests.java | 12 ----------- .../karaf/internal/InstallServiceCommand.java | 2 +- .../openhab/core/io/net/http/HttpUtil.java | 3 ++- .../RolesAllowedDynamicFeatureImpl.java | 2 +- .../auth/internal/TokenEndpointException.java | 3 ++- .../rest/auth/internal/TokenResponseDTO.java | 3 ++- .../auth/internal/TokenResponseErrorDTO.java | 3 ++- .../auth/internal/UserSecurityContext.java | 2 +- .../internal/JerseyResponseBuilderUtils.java | 3 ++- .../sitemap/internal/SitemapResource.java | 3 --- .../modbus/internal/ModbusLibraryWrapper.java | 4 ++-- .../modbus/internal/ModbusManagerImpl.java | 4 ++-- .../modbus/internal/SimpleStopWatch.java | 2 +- .../io/transport/modbus/test/SmokeTest.java | 3 +-- .../transport/serial/SerialPortProvider.java | 3 +-- .../internal/KarafAddonFinderService.java | 2 +- .../core/model/script/actions/Exec.java | 1 - .../model/script/engine/ScriptException.java | 2 -- .../GenericItemChannelLinkProvider.java | 2 +- .../handler/MagicColorLightHandlerTest.java | 2 +- .../firmware/FirmwareUpdateHandler.java | 6 ++++-- .../binding/firmware/ProgressCallback.java | 2 +- .../internal/i18n/ChannelGroupI18nUtil.java | 2 +- .../thing/internal/i18n/ChannelI18nUtil.java | 4 ++-- .../profiles/i18n/ProfileI18nUtil.java | 2 +- .../openhab/core/thing/type/BridgeType.java | 6 ++---- .../internal/ChannelGroupTypeXmlResult.java | 3 +-- .../xml/internal/ThingTypeXmlProvider.java | 2 +- .../link/events/LinkEventFactoryTest.java | 2 +- .../org/openhab/core/voice/KSService.java | 2 +- .../org/openhab/core/voice/STTService.java | 2 +- .../internal/text/StandardInterpreter.java | 8 +++---- .../client/oauth2/OAuthClientService.java | 12 +++++------ .../core/common/ThreadPoolManager.java | 2 +- .../i18n/LanguageResourceBundleManager.java | 2 +- .../internal/i18n/ResourceBundleTracker.java | 2 +- .../internal/items/GroupFunctionHelper.java | 3 +-- .../items/ManagedMetadataProviderImpl.java | 2 +- .../core/library/types/QuantityType.java | 4 +++- .../core/library/unit/ImperialUnits.java | 2 +- .../org/openhab/core/library/unit/Units.java | 2 +- .../openhab/core/scheduler/CronAdjuster.java | 2 +- .../core/cache/ExpiringCacheAsyncTest.java | 2 +- .../core/events/AbstractEventFactoryTest.java | 2 +- .../core/items/dto/ItemDTOMapperTest.java | 3 --- .../items/events/ItemEventFactoryTest.java | 2 +- .../hue/TestHueThingTypeProvider.java | 2 -- 82 files changed, 122 insertions(+), 163 deletions(-) diff --git a/bundles/org.openhab.core.addon.marketplace/src/main/java/org/openhab/core/addon/marketplace/internal/automation/MarketplaceRuleTemplateProvider.java b/bundles/org.openhab.core.addon.marketplace/src/main/java/org/openhab/core/addon/marketplace/internal/automation/MarketplaceRuleTemplateProvider.java index f4d8e6889d3..e38f5bd4aa3 100644 --- a/bundles/org.openhab.core.addon.marketplace/src/main/java/org/openhab/core/addon/marketplace/internal/automation/MarketplaceRuleTemplateProvider.java +++ b/bundles/org.openhab.core.addon.marketplace/src/main/java/org/openhab/core/addon/marketplace/internal/automation/MarketplaceRuleTemplateProvider.java @@ -129,7 +129,7 @@ public void addTemplateAsJSON(String uid, String json) throws ParsingException { * This adds a new rule template to the persistent storage from its YAML representation. * * @param uid the UID to be used for the template - * @param json the template content as a YAML string + * @param yaml the template content as a YAML string * * @throws ParsingException if the content cannot be parsed correctly */ diff --git a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonDiscoveryMethodConverter.java b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonDiscoveryMethodConverter.java index 21e6390d7c9..a520b6a9c54 100644 --- a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonDiscoveryMethodConverter.java +++ b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonDiscoveryMethodConverter.java @@ -22,6 +22,7 @@ import org.openhab.core.config.core.xml.util.GenericUnmarshaller; import org.openhab.core.config.core.xml.util.NodeIterator; +import com.thoughtworks.xstream.converters.Converter; import com.thoughtworks.xstream.converters.UnmarshallingContext; import com.thoughtworks.xstream.io.HierarchicalStreamReader; diff --git a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoXmlProvider.java b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoXmlProvider.java index 60d28ec2837..d3f25096d29 100644 --- a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoXmlProvider.java +++ b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonInfoXmlProvider.java @@ -26,7 +26,8 @@ * objects by a {@link AddonInfoReader} for a certain bundle. *

* This implementation registers each {@link AddonInfo} object at the {@link XmlAddonInfoProvider} which is itself - * registered as {@link AddonInfoProvider} service at the OSGi service registry. + * registered as {@link org.openhab.core.addon.AddonInfoProvider AddonInfoProvider} service at the OSGi service + * registry. *

* If there is a {@link ConfigDescription} object within the {@link AddonInfoXmlResult} object, it is added to the * {@link AbstractXmlConfigDescriptionProvider} which is itself registered as OSGi service at the service diff --git a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonMatchPropertyConverter.java b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonMatchPropertyConverter.java index f8f5321d9de..bc890ea544c 100644 --- a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonMatchPropertyConverter.java +++ b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonMatchPropertyConverter.java @@ -20,6 +20,7 @@ import org.openhab.core.config.core.xml.util.GenericUnmarshaller; import org.openhab.core.config.core.xml.util.NodeIterator; +import com.thoughtworks.xstream.converters.Converter; import com.thoughtworks.xstream.converters.UnmarshallingContext; import com.thoughtworks.xstream.io.HierarchicalStreamReader; diff --git a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonParameterConverter.java b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonParameterConverter.java index ea9c3a45233..8c88cdcf6ad 100644 --- a/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonParameterConverter.java +++ b/bundles/org.openhab.core.addon/src/main/java/org/openhab/core/addon/internal/xml/AddonParameterConverter.java @@ -21,6 +21,7 @@ import org.openhab.core.config.core.xml.util.GenericUnmarshaller; import org.openhab.core.config.core.xml.util.NodeIterator; +import com.thoughtworks.xstream.converters.Converter; import com.thoughtworks.xstream.converters.UnmarshallingContext; import com.thoughtworks.xstream.io.HierarchicalStreamReader; diff --git a/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/javasound/AudioPlayer.java b/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/javasound/AudioPlayer.java index e127b1f5589..346cb523775 100644 --- a/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/javasound/AudioPlayer.java +++ b/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/javasound/AudioPlayer.java @@ -49,7 +49,7 @@ public class AudioPlayer extends Thread { /** * Constructs an AudioPlayer to play the passed AudioSource * - * @param audioSource The AudioSource to play + * @param audioStream The AudioStream to play */ public AudioPlayer(AudioStream audioStream) { this.audioStream = audioStream; diff --git a/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/webaudio/PlayURLEvent.java b/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/webaudio/PlayURLEvent.java index 3e6e0a36157..990262eb49d 100644 --- a/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/webaudio/PlayURLEvent.java +++ b/bundles/org.openhab.core.audio/src/main/java/org/openhab/core/audio/internal/webaudio/PlayURLEvent.java @@ -16,7 +16,8 @@ import org.openhab.core.events.AbstractEvent; /** - * This is an {@link Event} that is sent when a web client should play an audio stream from a url. + * This is an {@link org.openhab.core.events.Event Event} that is sent when a web client should play an audio stream + * from a url. * * @author Kai Kreuzer - Initial contribution and API */ diff --git a/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthClientServiceImpl.java b/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthClientServiceImpl.java index ac9af38f916..d5c8ebdd6b8 100644 --- a/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthClientServiceImpl.java +++ b/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthClientServiceImpl.java @@ -89,7 +89,6 @@ private OAuthClientServiceImpl(String handle, int tokenExpiresInSeconds, HttpCli /** * It should only be used internally, thus the access is package level * - * @param bundleContext Bundle Context * @param handle The handle produced previously from * {@link org.openhab.core.auth.client.oauth2.OAuthFactory#createOAuthClientService} * @param storeHandler Storage handler @@ -119,12 +118,11 @@ private OAuthClientServiceImpl(String handle, int tokenExpiresInSeconds, HttpCli /** * It should only be used internally, thus the access is package level * - * @param bundleContext Bundle Context* * @param handle The handle produced previously from * {@link org.openhab.core.auth.client.oauth2.OAuthFactory#createOAuthClientService}* * @param storeHandler Storage handler * @param httpClientFactory Http client factory - * @param persistedParams These parameters are static with respect to the OAuth provider and thus can be persisted. + * @param params These parameters are static with respect to the OAuth provider and thus can be persisted. * @return OAuthClientServiceImpl an instance */ static OAuthClientServiceImpl createInstance(String handle, OAuthStoreHandler storeHandler, diff --git a/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthConnector.java b/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthConnector.java index fd2d4fad1e5..ba416ec5539 100644 --- a/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthConnector.java +++ b/bundles/org.openhab.core.auth.oauth2client/src/main/java/org/openhab/core/auth/oauth2client/internal/OAuthConnector.java @@ -356,14 +356,16 @@ private AccessTokenResponse doRequest(final String grantType, HttpClient httpCli /** * This is a special case where the httpClient (jetty) is created due to the need for certificate pinning. - * If certificate pinning is needed, please refer to {@code TrustManagerProvider}. The http client is - * created, used and then shutdown immediately after use. There is little reason to cache the client/ connections + * If certificate pinning is needed, please refer to + * {@code org.openhab.core.io.net.http.ExtensibleTrustManager ExtensibleTrustManager}. + * The http client is created, used and then shutdown immediately after use. There is little reason to cache the + * client/ connections * because oauth requests are short; and it may take hours/ days before the next request is needed. * * @param tokenUrl access token url * @return http client. This http client * @throws OAuthException If any exception is thrown while starting the http client. - * @see TrustManagerProvider + * @see org.openhab.core.io.net.http.ExtensibleTrustManager */ private HttpClient createHttpClient(String tokenUrl) throws OAuthException { HttpClient httpClient = httpClientFactory.createHttpClient(HTTP_CLIENT_CONSUMER_NAME); diff --git a/bundles/org.openhab.core.auth.oauth2client/src/test/java/org/openhab/core/auth/oauth2client/internal/OAuthStoreHandlerTest.java b/bundles/org.openhab.core.auth.oauth2client/src/test/java/org/openhab/core/auth/oauth2client/internal/OAuthStoreHandlerTest.java index 0e7561c18b1..e01919ff544 100644 --- a/bundles/org.openhab.core.auth.oauth2client/src/test/java/org/openhab/core/auth/oauth2client/internal/OAuthStoreHandlerTest.java +++ b/bundles/org.openhab.core.auth.oauth2client/src/test/java/org/openhab/core/auth/oauth2client/internal/OAuthStoreHandlerTest.java @@ -38,7 +38,7 @@ /** * The {@link OAuthStoreHandlerTest} contains tests for - * {@link org.openhab.core.auth.oauth2client.OAuthStoreHandlerImpl} + * {@link org.openhab.core.auth.oauth2client.internal.OAuthStoreHandlerImpl} * * @author Jacob Laursen - Initial contribution */ diff --git a/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java b/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java index dce05230548..fa530513fed 100644 --- a/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java +++ b/bundles/org.openhab.core.automation.module.script/src/main/java/org/openhab/core/automation/module/script/internal/provider/ScriptModuleTypeProvider.java @@ -99,7 +99,7 @@ private List getModuleTypesUnconditionally(@Nullable Locale locale) } /** - * This method creates the {@link ConfigurationDescriptionParameter}s used by the generated ScriptActionType and + * This method creates the {@link ConfigDescriptionParameter}s used by the generated ScriptActionType and * ScriptConditionType. {@link AbstractScriptModuleHandler} requires that the names of these be 'type' and 'script'. * * @return a list of {#link ConfigurationDescriptionParameter}s diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/RulePredicates.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/RulePredicates.java index d7fbee8891f..4563ad7b120 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/RulePredicates.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/RulePredicates.java @@ -44,9 +44,9 @@ public class RulePredicates { *
* The name space is part of the UID and the prefix thereof. *
- * If the UID does not contain a {@link PREFIX_SEPARATOR} {@code null} will be returned. + * If the UID does not contain a {@link #PREFIX_SEPARATOR} {@code null} will be returned. *
- * If the UID does contain a {@link PREFIX_SEPARATOR} the prefix until the first occurrence will be returned. + * If the UID does contain a {@link #PREFIX_SEPARATOR} the prefix until the first occurrence will be returned. *
* If the prefix would have a zero length {@code null} will be returned. * diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleExecutionSimulator.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleExecutionSimulator.java index b3847fd470f..faabb06bf4e 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleExecutionSimulator.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleExecutionSimulator.java @@ -110,7 +110,7 @@ private List simulateExecutionsForRule(Rule rule, ZonedDateTime f * @param rule {@link Rule} to be simulated. * @param from {@link ZonedDateTime} earliest time to be contained in the rule simulation. * @param until {@link ZonedDateTime} latest time to be contained in the rule simulation. - * @param cron cron-expression to be evaluated for determining the execution times. + * @param temporalAdjuster {@link SchedulerTemporalAdjuster} to be evaluated for determining the execution times. * @return a list of expected executions. */ private List simulateExecutionsForCronBasedRule(Rule rule, ZonedDateTime from, ZonedDateTime until, diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleRegistryImpl.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleRegistryImpl.java index 27fa4b9802a..bf0e959af13 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleRegistryImpl.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/RuleRegistryImpl.java @@ -63,7 +63,7 @@ * The {@link RuleRegistryImpl} provides basic functionality for managing {@link Rule}s. * It can be used to *

* * @author Ana Dimova - Initial contribution @@ -72,9 +71,7 @@ public class TemplateResourceBundleProvider extends AbstractResourceBundleProvid /** * This constructor is responsible for initializing the path to resources and tracking the managing service of the - * {@link ModuleType}s and the managing service of the {@link RuleTemplates}s. - * - * @param context is the {@code BundleContext}, used for creating a tracker for {@link Parser} services. + * {@link ModuleType}s and the managing service of the {@link RuleTemplate}s. */ @Activate public TemplateResourceBundleProvider(final @Reference ConfigI18nLocalizationService configI18nService, @@ -151,11 +148,11 @@ public Collection getTemplates(@Nullable Locale locale) { } /** - * This method is used to localize the {@link Template}s. + * This method is used to localize the {@link RuleTemplate}s. * - * @param element is the {@link Template} that must be localized. + * @param defTemplate is the {@link RuleTemplate} that must be localized. * @param locale represents a specific geographical, political, or cultural region. - * @return the localized {@link Template}. + * @return the localized {@link RuleTemplate}. */ private @Nullable RuleTemplate getPerLocale(@Nullable RuleTemplate defTemplate, @Nullable Locale locale) { if (locale == null || defTemplate == null) { diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/Vendor.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/Vendor.java index e3136d74594..4ee8d24bfb1 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/Vendor.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/Vendor.java @@ -58,7 +58,7 @@ public Vendor(String nameversion) { } /** - * This constructor initialize the {@link vendorId} and the {@link vendorVersion} of the vendor with corresponding + * This constructor initialize the {@link #vendorID} and the {@link #vendorVersion} of the vendor with corresponding * bundle ID and bundle version of a bundle that provides resources for the automation objects. * * @param name a bundle symbolic name of a bundle that providing resources for automation objects. @@ -71,7 +71,7 @@ public Vendor(String name, String version) { } /** - * Getter of {@link vendorSymbolicName}. + * Getter of {@link #vendorSymbolicName}. * * @return a bundle symbolic name of a bundle that provides resources for the automation objects. */ @@ -80,7 +80,7 @@ public String getVendorSymbolicName() { } /** - * Getter of {@link vendorId}. + * Getter of {@link #vendorID}. * * @return a bundle symbolic name of a bundle that provides resources for the automation objects. */ @@ -89,7 +89,7 @@ public String getVendorID() { } /** - * Getter of {@link vendorVersion}. + * Getter of {@link #vendorVersion}. * * @return a bundle version of a bundle that provides resources for the automation objects. */ @@ -98,7 +98,7 @@ public String getVendorVersion() { } /** - * Setter of {@link vendorVersion}. + * Setter of {@link #vendorVersion}. * * @param version a bundle version of a bundle that provides resources for the automation objects. */ diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/file/AutomationWatchService.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/file/AutomationWatchService.java index cfa59acf274..253925deda0 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/file/AutomationWatchService.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/file/AutomationWatchService.java @@ -19,8 +19,8 @@ import org.openhab.core.service.WatchService; /** - * This class is an implementation of {@link AbstractWatchService} which is responsible for tracking changes in file - * system by Java WatchService. + * This class is an implementation of {@link WatchService.WatchEventListener} which is responsible for tracking file + * system changes. *

* It provides functionality for tracking {@link #watchingDir} changes to import or remove the automation objects. * diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nServiceImpl.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nServiceImpl.java index 346685f7f86..2f28ff16aae 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nServiceImpl.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nServiceImpl.java @@ -69,7 +69,7 @@ public ModuleTypeI18nServiceImpl(final @Reference ConfigI18nLocalizationService /** * This method is used to localize the {@link ModuleType}s. * - * @param element is the {@link ModuleType} that must be localized. + * @param defModuleType is the {@link ModuleType} that must be localized. * @param locale represents a specific geographical, political, or cultural region. * @return the localized {@link ModuleType}. */ @@ -180,7 +180,7 @@ public ModuleTypeI18nServiceImpl(final @Reference ConfigI18nLocalizationService /** * Utility method for localization of TriggerTypes. * - * @param ct is a TriggerType for localization. + * @param tt is a TriggerType for localization. * @param bundle the bundle providing localization resources. * @param moduleTypeUID is a TriggerType uid. * @param locale represents a specific geographical, political, or cultural region. diff --git a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nUtil.java b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nUtil.java index 0df0fc71243..d675719b0b4 100644 --- a/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nUtil.java +++ b/bundles/org.openhab.core.automation/src/main/java/org/openhab/core/automation/internal/provider/i18n/ModuleTypeI18nUtil.java @@ -25,8 +25,10 @@ import org.osgi.framework.Bundle; /** - * This class is used as utility for resolving the localized {@link ModuleTypes}s. It automatically infers the key if - * the default text is not a constant with the assistance of {@link TranslationProvider}. + * This class is used as utility for resolving the localized {@link org.openhab.core.automation.type.ModuleType + * ModuleTypes}s. + * It automatically infers the key if the default text is not a constant with the assistance of + * {@link TranslationProvider}. * * @author Ana Dimova - Initial contribution * @author Yordan Mihaylov - updates related to api changes diff --git a/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/internal/ConfigDescriptionXmlProvider.java b/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/internal/ConfigDescriptionXmlProvider.java index 8d6578da166..a21c9ceb316 100644 --- a/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/internal/ConfigDescriptionXmlProvider.java +++ b/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/internal/ConfigDescriptionXmlProvider.java @@ -30,8 +30,6 @@ * is itself registered as {@link ConfigDescriptionProvider} service at the OSGi service registry. * * @author Michael Grammling - Initial contribution - * - * @see ConfigDescriptionXmlProviderFactory */ @NonNullByDefault public class ConfigDescriptionXmlProvider implements XmlDocumentProvider> { diff --git a/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java b/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java index 5c2754c6f6f..8293aaa61f9 100644 --- a/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java +++ b/bundles/org.openhab.core.config.core/src/main/java/org/openhab/core/config/core/xml/util/XmlDocumentReader.java @@ -71,7 +71,7 @@ protected void setClassLoader(ClassLoader classLoader) { * * @param xstream the XStream object to be configured * - * @see https://x-stream.github.io/security.html + * @see XStream - Security Aspects */ protected void configureSecurity(XStream xstream) { xstream.allowTypesByWildcard(DEFAULT_ALLOWED_TYPES_WILDCARD); diff --git a/bundles/org.openhab.core.config.core/src/test/java/org/openhab/core/config/xml/util/XmlDocumentReaderTest.java b/bundles/org.openhab.core.config.core/src/test/java/org/openhab/core/config/xml/util/XmlDocumentReaderTest.java index e778aa5323f..bcc9b812b99 100644 --- a/bundles/org.openhab.core.config.core/src/test/java/org/openhab/core/config/xml/util/XmlDocumentReaderTest.java +++ b/bundles/org.openhab.core.config.core/src/test/java/org/openhab/core/config/xml/util/XmlDocumentReaderTest.java @@ -85,7 +85,7 @@ public void defaultSecurityDisallowsDeserializingNonOHCobjects() throws Exceptio } /** - * @see https://x-stream.github.io/CVE-2013-7285.html + * @see XStream - CVE-2013-7285 */ @Test public void defaultSecurityProtectsAgainstRemoteCodeExecution() throws Exception { @@ -105,7 +105,7 @@ public void defaultSecurityProtectsAgainstRemoteCodeExecution() throws Exception } /** - * @see https://x-stream.github.io/CVE-2017-7957.html + * @see XStream - CVE-2017-7957 */ @Test public void defaultSecurityProtectsAgainstDenialOfServiceAttacks() throws Exception { diff --git a/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java b/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java index c1ff498cc70..4e260cfd69e 100644 --- a/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java +++ b/bundles/org.openhab.core.config.discovery.addon.ip/src/main/java/org/openhab/core/config/discovery/addon/ip/IpAddonFinder.java @@ -117,7 +117,7 @@ *

    *
  • Currently every returned frame is considered as success, regex matching is not implemented. *
  • Frames are sent only on startup (or if an {@link org.openhab.core.addon.AddonInfoProvider} - * calls {@link setAddonCandidates}), no background scanning. + * calls {@link #setAddonCandidates(List)}), no background scanning. *
      * * @apiNote The {@link IpAddonFinder} is still under active development, it has initially diff --git a/bundles/org.openhab.core.config.discovery.addon.upnp/src/test/java/org/openhab/core/config/discovery/addon/upnp/tests/UpnpAddonFinderTests.java b/bundles/org.openhab.core.config.discovery.addon.upnp/src/test/java/org/openhab/core/config/discovery/addon/upnp/tests/UpnpAddonFinderTests.java index 8c5bd09a6e0..bc2dd6d84e9 100644 --- a/bundles/org.openhab.core.config.discovery.addon.upnp/src/test/java/org/openhab/core/config/discovery/addon/upnp/tests/UpnpAddonFinderTests.java +++ b/bundles/org.openhab.core.config.discovery.addon.upnp/src/test/java/org/openhab/core/config/discovery/addon/upnp/tests/UpnpAddonFinderTests.java @@ -12,18 +12,6 @@ */ package org.openhab.core.config.discovery.addon.upnp.tests; -/** - * Copyright (c) 2010-2023 Contributors to the openHAB project - * - * See the NOTICE file(s) distributed with this work for additional - * information. - * - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License 2.0 which is available at - * http://www.eclipse.org/legal/epl-2.0 - * - * SPDX-License-Identifier: EPL-2.0 - */ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotNull; diff --git a/bundles/org.openhab.core.io.console.karaf/src/main/java/org/openhab/core/io/console/karaf/internal/InstallServiceCommand.java b/bundles/org.openhab.core.io.console.karaf/src/main/java/org/openhab/core/io/console/karaf/internal/InstallServiceCommand.java index ab157e2e81c..f63290414ed 100644 --- a/bundles/org.openhab.core.io.console.karaf/src/main/java/org/openhab/core/io/console/karaf/internal/InstallServiceCommand.java +++ b/bundles/org.openhab.core.io.console.karaf/src/main/java/org/openhab/core/io/console/karaf/internal/InstallServiceCommand.java @@ -415,7 +415,7 @@ private void safeClose(InputStream is) { /** * Silently close outputstream * - * @param is + * @param os * outputstream */ private void safeClose(OutputStream os) { diff --git a/bundles/org.openhab.core.io.net/src/main/java/org/openhab/core/io/net/http/HttpUtil.java b/bundles/org.openhab.core.io.net/src/main/java/org/openhab/core/io/net/http/HttpUtil.java index bb2f593b155..f18cb7342b4 100644 --- a/bundles/org.openhab.core.io.net/src/main/java/org/openhab/core/io/net/http/HttpUtil.java +++ b/bundles/org.openhab.core.io.net/src/main/java/org/openhab/core/io/net/http/HttpUtil.java @@ -526,7 +526,8 @@ public static String guessContentTypeFromData(byte[] data) { * Check whether the content data is a JPEG file checking file start and end bytes. * {@link URLConnection#guessContentTypeFromStream(InputStream)} is wrong for some JPEG files. * - * @see https://en.wikipedia.org/wiki/JPEG#Syntax_and_structure + * @see JPEG Syntax and structure + * * @param data the data as buffer of bytes * @return true if the content is a JPEG file, false otherwise */ diff --git a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/RolesAllowedDynamicFeatureImpl.java b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/RolesAllowedDynamicFeatureImpl.java index a1746ea26c0..2bc966f8e07 100644 --- a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/RolesAllowedDynamicFeatureImpl.java +++ b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/RolesAllowedDynamicFeatureImpl.java @@ -45,7 +45,7 @@ * {@code javax.annotation.security.PermitAll} and {@code javax.annotation.security.DenyAll} * on resource methods and sub-resource methods. * - * Ported from {@link RolesAllowedDynamicFeature} with modifications. + * Ported from the Jersey {@code RolesAllowedDynamicFeature} class with modifications. * * @author Paul Sandoz - initial contribution * @author Martin Matula - initial contribution diff --git a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenEndpointException.java b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenEndpointException.java index 0fb733960a4..a59b88a019b 100644 --- a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenEndpointException.java +++ b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenEndpointException.java @@ -19,7 +19,8 @@ * An exception when the token endpoint encounters an error and must return an error response, according to RFC 6749 * Section 5.2. * - * {@linkplain https://tools.ietf.org/html/rfc6749#section-5.2} + * @see RFC 6749: Issuing an Access Token - Error + * Response * * @author Yannick Schaus - initial contribution */ diff --git a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseDTO.java b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseDTO.java index e48c39d8b8f..4f2d9eb033c 100644 --- a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseDTO.java +++ b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseDTO.java @@ -17,7 +17,8 @@ /** * A DTO object for a successful token endpoint response, as per RFC 6749, Section 5.1. * - * {@linkplain https://tools.ietf.org/html/rfc6749#section-5.1} + * @see RFC 6749: Issuing an Access Token - + * Successful Response * * @author Yannick Schaus - initial contribution */ diff --git a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseErrorDTO.java b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseErrorDTO.java index 08516e3a623..fc34b78cb96 100644 --- a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseErrorDTO.java +++ b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/TokenResponseErrorDTO.java @@ -15,7 +15,8 @@ /** * A DTO object for an unsuccessful token endpoint response, as per RFC 6749, Section 5.2. * - * {@linkplain https://tools.ietf.org/html/rfc6749#section-5.2} + * @see RFC 6749: Issuing an Access Token - Error + * Response * * @author Yannick Schaus - initial contribution */ diff --git a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/UserSecurityContext.java b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/UserSecurityContext.java index 3e43aea40a5..7626c4da330 100644 --- a/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/UserSecurityContext.java +++ b/bundles/org.openhab.core.io.rest.auth/src/main/java/org/openhab/core/io/rest/auth/internal/UserSecurityContext.java @@ -38,7 +38,7 @@ public class UserSecurityContext implements AuthenticationSecurityContext { * Constructs a security context from an instance of {@link User} * * @param user the user - * @param the related {@link Authentication} + * @param authentication the related {@link Authentication} * @param authenticationScheme the scheme that was used to authenticate the user, e.g. "Basic" */ public UserSecurityContext(User user, Authentication authentication, String authenticationScheme) { diff --git a/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/JerseyResponseBuilderUtils.java b/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/JerseyResponseBuilderUtils.java index 01ba71b73c0..a2cda78f80c 100644 --- a/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/JerseyResponseBuilderUtils.java +++ b/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/JerseyResponseBuilderUtils.java @@ -25,7 +25,8 @@ * Data transfer object until UIs are fixed. * *

      - * {@link https://github.com/openhab/openhab-core/issues/1216} + * + * @see Sitemap Events: registration response buggy * * @author Markus Rathgeb - Initial contribution */ diff --git a/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/SitemapResource.java b/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/SitemapResource.java index 55a46ea95e5..b24d9138ade 100644 --- a/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/SitemapResource.java +++ b/bundles/org.openhab.core.io.rest.sitemap/src/main/java/org/openhab/core/io/rest/sitemap/internal/SitemapResource.java @@ -333,9 +333,6 @@ public Object createEventSubscription() { /** * Subscribes the connecting client to the stream of sitemap events. - * - * @return {@link EventOutput} object associated with the incoming - * connection. */ @GET @Path(SEGMENT_EVENTS + "/{subscriptionid: [a-zA-Z_0-9-]+}") diff --git a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusLibraryWrapper.java b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusLibraryWrapper.java index b8a15504266..a2c5145410e 100644 --- a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusLibraryWrapper.java +++ b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusLibraryWrapper.java @@ -264,7 +264,7 @@ public static BitVector convertBits(BitArray bits) { /** * Convert {@link ModbusRegisterArray} to array of {@link Register} * - * @param bits + * @param arr * @return */ public static Register[] convertRegisters(ModbusRegisterArray arr) { @@ -303,7 +303,7 @@ public static int getNumberOfItemsInResponse(ModbusResponse response, ModbusRead /** * Invoke callback with the data received * - * @param message original request + * @param request original request * @param callback callback for read * @param response Modbus library response object */ diff --git a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusManagerImpl.java b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusManagerImpl.java index 59cdd050f2f..32754006c17 100644 --- a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusManagerImpl.java +++ b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/ModbusManagerImpl.java @@ -444,7 +444,7 @@ private void returnConnection(ModbusSlaveEndpoint endpoint, Optional, } int tryIndex = 0; - /** + /* * last execution is tracked such that the endpoint is not spammed on retry. First retry can be executed * right away since getConnection ensures enough time has passed since last transaction. More precisely, * ModbusSlaveConnectionFactoryImpl sleeps on activate() (i.e. before returning connection). diff --git a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/SimpleStopWatch.java b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/SimpleStopWatch.java index 09312621233..68e5d5e9c13 100644 --- a/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/SimpleStopWatch.java +++ b/bundles/org.openhab.core.io.transport.modbus/src/main/java/org/openhab/core/io/transport/modbus/internal/SimpleStopWatch.java @@ -143,7 +143,7 @@ public void timeRunnableWithModbusException(RunnableWithModbusException action) * * First StopWatch is resumed, then action is applied. Finally the StopWatch is suspended. * - * @param supplier action to time + * @param runnable action to time * @return return value from supplier */ public void timeRunnable(Runnable runnable) { diff --git a/bundles/org.openhab.core.io.transport.modbus/src/test/java/org/openhab/core/io/transport/modbus/test/SmokeTest.java b/bundles/org.openhab.core.io.transport.modbus/src/test/java/org/openhab/core/io/transport/modbus/test/SmokeTest.java index b8336badaa3..586501c26c8 100644 --- a/bundles/org.openhab.core.io.transport.modbus/src/test/java/org/openhab/core/io/transport/modbus/test/SmokeTest.java +++ b/bundles/org.openhab.core.io.transport.modbus/src/test/java/org/openhab/core/io/transport/modbus/test/SmokeTest.java @@ -695,8 +695,7 @@ public void testRegularReadFirstErrorThenOK() throws Exception { /** * * @param unexpectedCount number of unexpected callback calls - * @param callbackCalled number of callback calls (including unexpected) - * @param dataReceived number of expected callback calls (onBits or onRegisters) + * @param expectedCount number of expected callback calls (onBits or onRegisters) * @param pollStartMillis poll start time in milliepoch * @param expectedPollAverageMin average poll period should be at least greater than this * @param expectedPollAverageMax average poll period less than this diff --git a/bundles/org.openhab.core.io.transport.serial/src/main/java/org/openhab/core/io/transport/serial/SerialPortProvider.java b/bundles/org.openhab.core.io.transport.serial/src/main/java/org/openhab/core/io/transport/serial/SerialPortProvider.java index caf68b4fe47..8094cfd73ea 100644 --- a/bundles/org.openhab.core.io.transport.serial/src/main/java/org/openhab/core/io/transport/serial/SerialPortProvider.java +++ b/bundles/org.openhab.core.io.transport.serial/src/main/java/org/openhab/core/io/transport/serial/SerialPortProvider.java @@ -30,8 +30,7 @@ public interface SerialPortProvider { * Gets the {@link SerialPortIdentifier} if it is available or null otherwise. * * @param portName The ports name. - * @return The created {@link SerialPort}. - * @throws NoSuchPortException If the serial port does not exist. + * @return The created {@link SerialPort} or null if the serial port does not exist. * @throws UnsupportedCommOperationException * @throws PortInUseException */ diff --git a/bundles/org.openhab.core.karaf/src/main/java/org/openhab/core/karaf/internal/KarafAddonFinderService.java b/bundles/org.openhab.core.karaf/src/main/java/org/openhab/core/karaf/internal/KarafAddonFinderService.java index 44af93c377a..5f5fb754426 100644 --- a/bundles/org.openhab.core.karaf/src/main/java/org/openhab/core/karaf/internal/KarafAddonFinderService.java +++ b/bundles/org.openhab.core.karaf/src/main/java/org/openhab/core/karaf/internal/KarafAddonFinderService.java @@ -23,7 +23,7 @@ import org.slf4j.LoggerFactory; /** - * This service is an implementation of an openHAB {@link AddonSuggestionFinderService} using the Karaf features + * This service is an implementation of an openHAB {@link AddonFinderService} using the Karaf features * service. This service allows dynamic installation/removal of add-on suggestion finders. * * @author Mark Herwege - Initial contribution diff --git a/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/Exec.java b/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/Exec.java index b83aa640207..efd5d7cd087 100644 --- a/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/Exec.java +++ b/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/Exec.java @@ -34,7 +34,6 @@ public class Exec { * * @param commandLine * the command line to execute - * @see http://www.peterfriese.de/running-applescript-from-java/ */ public static void executeCommandLine(String... commandLine) { ExecUtil.executeCommandLine(commandLine); diff --git a/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/engine/ScriptException.java b/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/engine/ScriptException.java index 721950f258f..bad199e2a3c 100644 --- a/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/engine/ScriptException.java +++ b/bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/engine/ScriptException.java @@ -74,8 +74,6 @@ private ScriptException(final Throwable cause, final String scriptText, final Sc /** * Creates a ScriptException with one Error. - * - * @param errors */ private ScriptException(final String scriptText, final ScriptError error) { super(error.getMessage()); // ? diff --git a/bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/GenericItemChannelLinkProvider.java b/bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/GenericItemChannelLinkProvider.java index 73317d9610c..c108c5d65cb 100644 --- a/bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/GenericItemChannelLinkProvider.java +++ b/bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/GenericItemChannelLinkProvider.java @@ -44,7 +44,7 @@ public class GenericItemChannelLinkProvider extends AbstractProvider> itemChannelLinkMap = new ConcurrentHashMap<>(); /** diff --git a/bundles/org.openhab.core.test.magic/src/test/java/org/openhab/core/magic/binding/handler/MagicColorLightHandlerTest.java b/bundles/org.openhab.core.test.magic/src/test/java/org/openhab/core/magic/binding/handler/MagicColorLightHandlerTest.java index ab875f393e4..cb7abb0f0f1 100644 --- a/bundles/org.openhab.core.test.magic/src/test/java/org/openhab/core/magic/binding/handler/MagicColorLightHandlerTest.java +++ b/bundles/org.openhab.core.test.magic/src/test/java/org/openhab/core/magic/binding/handler/MagicColorLightHandlerTest.java @@ -31,7 +31,7 @@ import org.openhab.core.thing.binding.ThingHandlerCallback; /** - * Tests cases for {@link MagicONOffLightHandler}. The tests provide mocks for supporting entities using Mockito. + * Tests cases for {@link MagicColorLightHandler}. The tests provide mocks for supporting entities using Mockito. * * @author Henning Treu - Initial contribution */ diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/FirmwareUpdateHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/FirmwareUpdateHandler.java index 02c705addd5..a0f507c7854 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/FirmwareUpdateHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/FirmwareUpdateHandler.java @@ -12,18 +12,20 @@ */ package org.openhab.core.thing.binding.firmware; +import java.util.Locale; + import org.eclipse.jdt.annotation.NonNullByDefault; import org.openhab.core.thing.Thing; import org.openhab.core.thing.ThingStatus; import org.openhab.core.thing.ThingStatusDetail; +import org.openhab.core.thing.ThingUID; import org.openhab.core.thing.firmware.FirmwareUpdateService; /** * The {@link FirmwareUpdateHandler} can be implemented and registered as an OSGi service in order to update the * firmware for the physical device of a {@link Thing}. The {@link FirmwareUpdateService} tracks each firmware * update handler and starts the firmware update process by the operation - * {@link FirmwareUpdateService#updateFirmware(org.openhab.core.thing.ThingUID, FirmwareUID, java.util.Locale)} - * . + * {@link FirmwareUpdateService#updateFirmware(ThingUID, String, Locale)}. * * @author Thomas Höfer - Initial contribution */ diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java index 70a44312c7f..acf61a94718 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/firmware/ProgressCallback.java @@ -28,7 +28,7 @@ * * For updates which are based on a percentage progress it is optional to define a sequence of {@link ProgressStep}s and * to use the {@link ProgressCallback#next()} method. In order to indicate that the percentage progress has changed, the - * method {@link ProgressCallback#update(progress)} has to be used. It allows to update the percentage progress to a + * method {@link ProgressCallback#update(int)} has to be used. It allows to update the percentage progress to a * value between 0 and 100. * * @author Thomas Höfer - Initial contribution diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelGroupI18nUtil.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelGroupI18nUtil.java index c51b34e7be4..f16f3f51aac 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelGroupI18nUtil.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelGroupI18nUtil.java @@ -30,7 +30,7 @@ * A utility service which localizes {@link ChannelGroupDefinition}. * Falls back to a localized {@link ChannelGroupType} for label and description when not given otherwise. * - * @see {@link ThingTypeI18nLocalizationService} + * @see org.openhab.core.thing.i18n.ThingTypeI18nLocalizationService ThingTypeI18nLocalizationService * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelI18nUtil.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelI18nUtil.java index 210866edddc..8feecffb7ef 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelI18nUtil.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/i18n/ChannelI18nUtil.java @@ -31,8 +31,8 @@ * A utility service which localises {@link ChannelDefinition}. * Falls back to a localised {@link ChannelType} for label and description when not given otherwise. * - * @see {@link ThingTypeI18nLocalizationService} - * @see {@link ChannelGroupTypeI18nLocalizationService} + * @see org.openhab.core.thing.i18n.ThingTypeI18nLocalizationService ThingTypeI18nLocalizationService + * @see org.openhab.core.thing.i18n.ChannelGroupTypeI18nLocalizationService ChannelGroupTypeI18nLocalizationService * * @author Henning Treu - Initial contribution */ diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/profiles/i18n/ProfileI18nUtil.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/profiles/i18n/ProfileI18nUtil.java index c5f750253d7..331d060128c 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/profiles/i18n/ProfileI18nUtil.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/internal/profiles/i18n/ProfileI18nUtil.java @@ -27,7 +27,7 @@ * A utility service which localizes {@link Profile}s. * Falls back to a localized {@link ProfileType} for label and description when not given otherwise. * - * @see {@link ProfileTypeI18nLocalizationService} + * @see org.openhab.core.thing.profiles.i18n.ProfileTypeI18nLocalizationService * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/BridgeType.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/BridgeType.java index 98b77684acb..4e4ecc94ee5 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/BridgeType.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/type/BridgeType.java @@ -39,9 +39,7 @@ public class BridgeType extends ThingType { /** * A new instance of BridgeType. * - * @see ThingType(uid, supportedBridgeTypeUIDs, label, description, category, listed, representationProperty, - * channelDefinitions, channelGroupDefinitions, properties, configDescriptionURI, - * extensibleChannelTypeIds) + * @see ThingType#ThingType(ThingTypeUID, List, String, String, String, boolean, String, List, List, Map, URI, List) * * @param uid the unique identifier which identifies this Thing type within the overall system * (must neither be null, nor empty) @@ -60,7 +58,7 @@ public class BridgeType extends ThingType { * @param properties the properties this Thing type provides (could be null) * @param configDescriptionURI the link to the concrete ConfigDescription (could be null) * @param extensibleChannelTypeIds the channel-type ids this thing-type is extensible with (could be null or empty). - * @throws IllegalArgumentException if the UID is null or empty, or the the meta information is null + * @throws IllegalArgumentException if the UID is null or empty, or the meta information is null */ BridgeType(ThingTypeUID uid, @Nullable List supportedBridgeTypeUIDs, String label, @Nullable String description, @Nullable String category, boolean listed, diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ChannelGroupTypeXmlResult.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ChannelGroupTypeXmlResult.java index da7aca5672d..7d58e61ba19 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ChannelGroupTypeXmlResult.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ChannelGroupTypeXmlResult.java @@ -14,7 +14,6 @@ import java.util.ArrayList; import java.util.List; -import java.util.Map; import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.Nullable; @@ -29,7 +28,7 @@ * The {@link ChannelGroupTypeXmlResult} is an intermediate XML conversion result object which * contains all parts of a {@link ChannelGroupType} object. *

      - * To create a concrete {@link ChannelGroupType} object, the method {@link #toChannelGroupType(Map)} must be called. + * To create a concrete {@link ChannelGroupType} object, the method {@link #toChannelGroupType()} must be called. * * @author Michael Grammling - Initial contribution * @author Chris Jackson - Updated to support channel properties diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ThingTypeXmlProvider.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ThingTypeXmlProvider.java index fd74c108928..3e5f52ee200 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ThingTypeXmlProvider.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/xml/internal/ThingTypeXmlProvider.java @@ -43,7 +43,7 @@ * service at the OSGi service registry. *

      * The {@link ThingTypeXmlProvider} uses an internal cache consisting of {@link #thingTypeRefs}, - * {@link #channelGroupTypeRefs}, {@link #channelGroupTypes} and {@link #channelTypes}. This cache is used to merge + * {@link #channelGroupTypeRefs}, {@link #channelTypeRefs}. This cache is used to merge * first the {@link ChannelType} definitions with the {@link ChannelGroupTypeXmlResult} objects to create valid * {@link ChannelGroupType} objects. After that the {@link ChannelType} and the {@link ChannelGroupType} definitions are * used to merge with the {@link ThingTypeXmlResult} objects to create valid {@link ThingType} objects. After the merge diff --git a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/link/events/LinkEventFactoryTest.java b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/link/events/LinkEventFactoryTest.java index c80c6014970..9c9b0c3e062 100644 --- a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/link/events/LinkEventFactoryTest.java +++ b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/link/events/LinkEventFactoryTest.java @@ -26,7 +26,7 @@ import com.google.gson.Gson; /** - * {@link LinkEventFactoryTests} tests the {@link LinkEventFactory}. + * {@link LinkEventFactoryTest} tests the {@link LinkEventFactory}. * * @author Christoph Weitkamp - Initial contribution */ diff --git a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/KSService.java b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/KSService.java index 1e220f390a8..efb90a49838 100644 --- a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/KSService.java +++ b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/KSService.java @@ -82,7 +82,7 @@ public interface KSService { * @param locale The {@code Locale} in which the target keywords are spoken * @param keyword The keyword which to spot * @return A {@link KSServiceHandle} used to abort keyword spotting - * @throws A {@link KSException} if any parameter is invalid or a problem occurs + * @throws KSException if any parameter is invalid or a problem occurs */ KSServiceHandle spot(KSListener ksListener, AudioStream audioStream, Locale locale, String keyword) throws KSException; diff --git a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/STTService.java b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/STTService.java index 28d0dfdb3cf..c9683cdbe4a 100644 --- a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/STTService.java +++ b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/STTService.java @@ -83,7 +83,7 @@ public interface STTService { * @param locale The {@code Locale} in which the target speech is spoken * @param grammars The JSpeech Grammar Format grammar specifying allowed statements * @return A {@link STTServiceHandle} used to abort recognition - * @throws A {@link STTException} if any parameter is invalid or a STT problem occurs + * @throws STTException if any parameter is invalid or a STT problem occurs */ STTServiceHandle recognize(STTListener sttListener, AudioStream audioStream, Locale locale, Set grammars) throws STTException; diff --git a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/internal/text/StandardInterpreter.java b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/internal/text/StandardInterpreter.java index 932c931c224..540385c6822 100644 --- a/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/internal/text/StandardInterpreter.java +++ b/bundles/org.openhab.core.voice/src/main/java/org/openhab/core/voice/internal/text/StandardInterpreter.java @@ -90,7 +90,7 @@ public Set getSupportedLocales() { @Override public void createRules(@Nullable Locale locale) { - /****************************** ENGLISH ******************************/ + /* ***************************** ENGLISH ***************************** */ if (locale == null || Objects.equals(locale.getLanguage(), Locale.ENGLISH.getLanguage())) { Expression onOff = alt(cmd("on", OnOffType.ON), cmd("off", OnOffType.OFF)); @@ -169,7 +169,7 @@ public void createRules(@Nullable Locale locale) { Locale.ENGLISH).toArray(Rule[]::new)); } - /****************************** GERMAN ******************************/ + /* ***************************** GERMAN ***************************** */ if (locale == null || Objects.equals(locale.getLanguage(), Locale.GERMAN.getLanguage())) { Expression einAnAus = alt(cmd("ein", OnOffType.ON), cmd("an", OnOffType.ON), cmd("aus", OnOffType.OFF)); @@ -237,7 +237,7 @@ public void createRules(@Nullable Locale locale) { Locale.GERMAN).toArray(Rule[]::new)); } - /****************************** FRENCH ******************************/ + /* ***************************** FRENCH ***************************** */ if (locale == null || Objects.equals(locale.getLanguage(), Locale.FRENCH.getLanguage())) { Expression allume = alt("allume", "démarre", "active"); @@ -304,7 +304,7 @@ public void createRules(@Nullable Locale locale) { Locale.FRENCH).toArray(Rule[]::new)); } - /****************************** SPANISH ******************************/ + /* ***************************** SPANISH ***************************** */ Locale localeES = new Locale("es"); if (locale == null || Objects.equals(locale.getLanguage(), localeES.getLanguage())) { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/auth/client/oauth2/OAuthClientService.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/auth/client/oauth2/OAuthClientService.java index 780f4cbd436..dc8f3b06e1c 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/auth/client/oauth2/OAuthClientService.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/auth/client/oauth2/OAuthClientService.java @@ -153,7 +153,7 @@ String getAuthorizationUrl(@Nullable String redirectURI, @Nullable String scope, * @return AccessTokenResponse * @throws IOException IO/ network exceptions * @throws OAuthException Other exceptions - * @throws OAuthErrorException Error codes given by authorization provider, as in RFC 6749 section 5.2 Error + * @throws OAuthResponseException Error codes given by authorization provider, as in RFC 6749 section 5.2 Error * Response * @see Access Token Request - rfc6749 section-4.1.3 * @see Error Response - rfc6749 section-5.2 @@ -171,7 +171,7 @@ AccessTokenResponse getAccessTokenResponseByAuthorizationCode(String authorizati * @return AccessTokenResponse * @throws IOException IO/ network exceptions * @throws OAuthException Other exceptions - * @throws OAuthErrorException Error codes given by authorization provider, as in RFC 6749 section 5.2 Error + * @throws OAuthResponseException Error codes given by authorization provider, as in RFC 6749 section 5.2 Error * Response * @see rfc6749 section-4.3.2 */ @@ -187,7 +187,7 @@ AccessTokenResponse getAccessTokenByResourceOwnerPasswordCredentials(String user * * @return new AccessTokenResponse from authorization server * @throws IOException Web/ network issues etc. - * @throws OAuthErrorException For OAUTH error responses. + * @throws OAuthResponseException For OAUTH error responses. * @throws OAuthException For other exceptions. * @see rfc6749 section-5.2 */ @@ -202,7 +202,7 @@ AccessTokenResponse getAccessTokenByResourceOwnerPasswordCredentials(String user * @param scope of the access, a space delimited separated list * @return AccessTokenResponse * @throws IOException Web/ network issues etc. - * @throws OAuthErrorException For OAUTH error responses. + * @throws OAuthResponseException For OAUTH error responses. * @throws OAuthException For other exceptions. */ AccessTokenResponse getAccessTokenByClientCredentials(@Nullable String scope) @@ -221,7 +221,7 @@ AccessTokenResponse getAccessTokenByClientCredentials(@Nullable String scope) * to prevent cross-site forgery. * @return AccessTokenResponse * @throws IOException Web/ network issues etc. - * @throws OAuthErrorException For OAUTH error responses. + * @throws OAuthResponseException For OAUTH error responses. * @throws OAuthException For other exceptions. * @see Implicit Grant - rfc6749 section-4.2 */ @@ -253,7 +253,7 @@ AccessTokenResponse getAccessTokenByImplicit(@Nullable String redirectURI, @Null * * @return AccessTokenResponse or null, depending on situations listed above. * @throws IOException Web/ network issues etc. - * @throws OAuthErrorException For OAUTH error responses. + * @throws OAuthResponseException For OAUTH error responses. * @throws OAuthException For other exceptions. */ @Nullable diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/common/ThreadPoolManager.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/common/ThreadPoolManager.java index 10887fb476f..af17525f0fb 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/common/ThreadPoolManager.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/common/ThreadPoolManager.java @@ -50,7 +50,7 @@ *
      * {@code org.openhab.core.threadpool:=} *
      - * All threads will time out after {@link THREAD_TIMEOUT}. + * All threads will time out after {@link #THREAD_TIMEOUT}. * * @author Kai Kreuzer - Initial contribution */ diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/LanguageResourceBundleManager.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/LanguageResourceBundleManager.java index 064c66c5c04..2340a3a7265 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/LanguageResourceBundleManager.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/LanguageResourceBundleManager.java @@ -27,7 +27,7 @@ /** * The {@link LanguageResourceBundleManager} class manages all available i18n resources for one - * specific OSGi bundle. Any i18n resource is searched within the {@link RESOURCE_DIRECTORY} of the bundle and + * specific OSGi bundle. Any i18n resource is searched within the {@link #RESOURCE_DIRECTORY} of the bundle and * not within the general bundle classpath. For the translation, the * i18n mechanism of Java ({@link ResourceBundle}) is used. *

      diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/ResourceBundleTracker.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/ResourceBundleTracker.java index b5598a7eb59..1c22cf9c6ff 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/ResourceBundleTracker.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/i18n/ResourceBundleTracker.java @@ -120,7 +120,7 @@ public Collection getAllLanguageResources() { /** * This method is used to get the host bundles of the parameter which is a fragment bundle. * - * @param bundle an OSGi fragment bundle. + * @param fragment an OSGi fragment bundle. * @return a list with the hosts of the fragment parameter. */ private List returnHostBundles(Bundle fragment) { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/GroupFunctionHelper.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/GroupFunctionHelper.java index 18df5f6d82a..d4343d27973 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/GroupFunctionHelper.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/GroupFunctionHelper.java @@ -48,8 +48,7 @@ public class GroupFunctionHelper { * arithmetic group function will take unit conversion into account. * * @param function the {@link GroupFunctionDTO} describing the group function. - * @param args a list of {@link State}s as arguments for the resulting group function. - * @param dimension an optional interface class from {@link Quantity} defining the dimension for unit conversion. + * @param baseItem an optional {@link Item} defining the dimension for unit conversion. * @return a {@link GroupFunction} according to the given parameters. */ public GroupFunction createGroupFunction(GroupFunctionDTO function, @Nullable Item baseItem) { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/ManagedMetadataProviderImpl.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/ManagedMetadataProviderImpl.java index 4b36e5f9442..68c1a155ed4 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/ManagedMetadataProviderImpl.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/internal/items/ManagedMetadataProviderImpl.java @@ -74,7 +74,7 @@ protected Metadata toPersistableElement(Metadata element) { /** * Removes all metadata of a given item * - * @param itemname the name of the item for which the metadata is to be removed. + * @param name the name of the item for which the metadata is to be removed. */ @Override public void removeItemMetadata(String name) { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/types/QuantityType.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/types/QuantityType.java index 7369584c748..52c13b663ab 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/types/QuantityType.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/types/QuantityType.java @@ -39,6 +39,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.Nullable; import org.openhab.core.internal.library.unit.UnitInitializer; +import org.openhab.core.items.events.ItemStateEvent; import org.openhab.core.library.unit.MetricPrefix; import org.openhab.core.library.unit.Units; import org.openhab.core.types.Command; @@ -87,7 +88,8 @@ public class QuantityType> extends Number /** * Creates a dimensionless {@link QuantityType} with scalar 0 and unit {@link AbstractUnit#ONE}. - * A default constructor is needed by {@link org.openhab.core.internal.items.ItemUpdater#receiveUpdate}) + * A default constructor is needed by + * {@link org.openhab.core.internal.items.ItemUpdater#receiveUpdate(ItemStateEvent)}) */ @SuppressWarnings("unchecked") public QuantityType() { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/ImperialUnits.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/ImperialUnits.java index c2fde0dcf79..b8a51fcaf9e 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/ImperialUnits.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/ImperialUnits.java @@ -94,7 +94,7 @@ public final class ImperialUnits extends CustomUnits { public static final Unit GALLON_PER_MINUTE = addUnit( new ProductUnit(GALLON_LIQUID_US.divide(tech.units.indriya.unit.Units.MINUTE))); - /** + /* * Add unit symbols for imperial units. */ static { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/Units.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/Units.java index c49f8bbef21..f6e6db9c048 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/Units.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/library/unit/Units.java @@ -233,7 +233,7 @@ public final class Units extends CustomUnits { public static final Unit GIGABIT_PER_SECOND = addUnit(MetricPrefix.GIGA(BIT_PER_SECOND)); public static final Unit TERABIT_PER_SECOND = addUnit(MetricPrefix.TERA(BIT_PER_SECOND)); - /** + /* * Add unit symbols for custom openHAB units. */ static { diff --git a/bundles/org.openhab.core/src/main/java/org/openhab/core/scheduler/CronAdjuster.java b/bundles/org.openhab.core/src/main/java/org/openhab/core/scheduler/CronAdjuster.java index 0d26c8198a0..37a8739fb4b 100644 --- a/bundles/org.openhab.core/src/main/java/org/openhab/core/scheduler/CronAdjuster.java +++ b/bundles/org.openhab.core/src/main/java/org/openhab/core/scheduler/CronAdjuster.java @@ -458,7 +458,7 @@ private int[] parseRange(final String cronExpression, final ChronoField chronoFi * because this object is ordered for temporal index no conversion is needed here. * * @param cronExpression the whole cron expression - * @param name the cron value to parse + * @param value the cron value to parse * @param names map with names of the week * @return temporal index of day of the week */ diff --git a/bundles/org.openhab.core/src/test/java/org/openhab/core/cache/ExpiringCacheAsyncTest.java b/bundles/org.openhab.core/src/test/java/org/openhab/core/cache/ExpiringCacheAsyncTest.java index 086453ed79a..d59cf6b75ee 100644 --- a/bundles/org.openhab.core/src/test/java/org/openhab/core/cache/ExpiringCacheAsyncTest.java +++ b/bundles/org.openhab.core/src/test/java/org/openhab/core/cache/ExpiringCacheAsyncTest.java @@ -24,7 +24,7 @@ import org.openhab.core.JavaTest; /** - * Tests cases for {@link ExpiringAsyncCache}. + * Tests cases for {@link ExpiringCacheAsync}. * * @author David Graeff - Initial contribution */ diff --git a/bundles/org.openhab.core/src/test/java/org/openhab/core/events/AbstractEventFactoryTest.java b/bundles/org.openhab.core/src/test/java/org/openhab/core/events/AbstractEventFactoryTest.java index 9633e06ab17..ac42fbaf8ff 100644 --- a/bundles/org.openhab.core/src/test/java/org/openhab/core/events/AbstractEventFactoryTest.java +++ b/bundles/org.openhab.core/src/test/java/org/openhab/core/events/AbstractEventFactoryTest.java @@ -19,7 +19,7 @@ import org.openhab.core.items.events.ItemEventFactory; /** - * {@link AbstractEventFactoryTests} tests the {@link org.openhab.core.events.AbstractEventFactory}. + * {@link AbstractEventFactoryTest} tests the {@link org.openhab.core.events.AbstractEventFactory}. * * @author Stefan Bußweiler - Initial contribution */ diff --git a/bundles/org.openhab.core/src/test/java/org/openhab/core/items/dto/ItemDTOMapperTest.java b/bundles/org.openhab.core/src/test/java/org/openhab/core/items/dto/ItemDTOMapperTest.java index d543ef47ffa..6480a8e9072 100644 --- a/bundles/org.openhab.core/src/test/java/org/openhab/core/items/dto/ItemDTOMapperTest.java +++ b/bundles/org.openhab.core/src/test/java/org/openhab/core/items/dto/ItemDTOMapperTest.java @@ -10,9 +10,6 @@ * * SPDX-License-Identifier: EPL-2.0 */ -/** - * @author Stefan Triller - Initial contribution - */ package org.openhab.core.items.dto; import static org.hamcrest.CoreMatchers.instanceOf; diff --git a/bundles/org.openhab.core/src/test/java/org/openhab/core/items/events/ItemEventFactoryTest.java b/bundles/org.openhab.core/src/test/java/org/openhab/core/items/events/ItemEventFactoryTest.java index 9ebc77f7990..f5b70859742 100644 --- a/bundles/org.openhab.core/src/test/java/org/openhab/core/items/events/ItemEventFactoryTest.java +++ b/bundles/org.openhab.core/src/test/java/org/openhab/core/items/events/ItemEventFactoryTest.java @@ -33,7 +33,7 @@ import com.google.gson.Gson; /** - * {@link ItemEventFactoryTests} tests the {@link ItemEventFactory}. + * {@link ItemEventFactoryTest} tests the {@link ItemEventFactory}. * * @author Stefan Bußweiler - Initial contribution */ diff --git a/itests/org.openhab.core.model.thing.testsupport/src/main/java/org/openhab/core/model/thing/testsupport/hue/TestHueThingTypeProvider.java b/itests/org.openhab.core.model.thing.testsupport/src/main/java/org/openhab/core/model/thing/testsupport/hue/TestHueThingTypeProvider.java index a7e02e3706f..64b99811c09 100644 --- a/itests/org.openhab.core.model.thing.testsupport/src/main/java/org/openhab/core/model/thing/testsupport/hue/TestHueThingTypeProvider.java +++ b/itests/org.openhab.core.model.thing.testsupport/src/main/java/org/openhab/core/model/thing/testsupport/hue/TestHueThingTypeProvider.java @@ -10,8 +10,6 @@ * * SPDX-License-Identifier: EPL-2.0 */ -/** - */ package org.openhab.core.model.thing.testsupport.hue; import java.net.URI;