public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[knx] Fix javadoc errors (#14174) 

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich 2023-01-14 13:02:31 +01:00 committed by GitHub
parent 649da669ac
commit 0f272d8523
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 44 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
bundles/org.openhab.binding.knx/pom.xml
View File

@ -57,4 +57,29 @@
</dependency> </dependency>
</dependencies> </dependencies>
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API note:</head>
</tag>
<tag>
<name>implNote</name>
<placement>a</placement>
<head>Implementation note:</head>
</tag>
</tags>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
</project> </project>

2
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/KNXBindingConstants.java
View File

@ -22,7 +22,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID; import org.openhab.core.thing.ThingTypeUID;
/** /**
* The {@link KNXBinding} class defines common constants, which are * The {@link KNXBindingConstants} class defines common constants, which are
* used across the whole binding. * used across the whole binding.
* *
* @author Karel Goderis - Initial contribution * @author Karel Goderis - Initial contribution

9
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/client/BusMessageListener.java
View File

@ -28,7 +28,8 @@ public interface BusMessageListener {
/** /**
* Called when the KNX bridge receives a group write telegram * Called when the KNX bridge receives a group write telegram
* *
* @param bridge * @param client
* @param source
* @param destination * @param destination
* @param asdu * @param asdu
*/ */
@ -37,7 +38,8 @@ public interface BusMessageListener {
/** /**
* Called when the KNX bridge receives a group read telegram * Called when the KNX bridge receives a group read telegram
* *
* @param bridge * @param client
* @param source
* @param destination * @param destination
* @param asdu * @param asdu
*/ */
@ -46,7 +48,8 @@ public interface BusMessageListener {
/** /**
* Called when the KNX bridge receives a group read response telegram * Called when the KNX bridge receives a group read response telegram
* *
* @param bridge * @param client
* @param source
* @param destination * @param destination
* @param asdu * @param asdu
*/ */

2
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/config/DeviceConfig.java
View File

@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
* Configuration object for the device thing handler. * Configuration object for the device thing handler.
* *
* @author Karel Goderis - Initial contribution * @author Karel Goderis - Initial contribution
* @author Simon Kaufmann - refactoring & cleanup * @author Simon Kaufmann - refactoring and cleanup
*/ */
@NonNullByDefault @NonNullByDefault
public class DeviceConfig { public class DeviceConfig {

2
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/IPBridgeThingHandler.java
View File

@ -40,7 +40,7 @@ import tuwien.auto.calimero.secure.KnxSecureException;
* directly defined on the bridge * directly defined on the bridge
* *
* @author Karel Goderis - Initial contribution * @author Karel Goderis - Initial contribution
* @author Simon Kaufmann - Refactoring & cleanup * @author Simon Kaufmann - Refactoring and cleanup
*/ */
@NonNullByDefault @NonNullByDefault
public class IPBridgeThingHandler extends KNXBridgeBaseThingHandler { public class IPBridgeThingHandler extends KNXBridgeBaseThingHandler {

2
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/SerialBridgeThingHandler.java
View File

@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory;
* directly defined on the bridge * directly defined on the bridge
* *
* @author Karel Goderis - Initial contribution * @author Karel Goderis - Initial contribution
* @author Simon Kaufmann - Refactoring & cleanup * @author Simon Kaufmann - Refactoring and cleanup
*/ */
@NonNullByDefault @NonNullByDefault
public class SerialBridgeThingHandler extends KNXBridgeBaseThingHandler { public class SerialBridgeThingHandler extends KNXBridgeBaseThingHandler {

17
bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/i18n/KNXTranslationProvider.java
View File

@ -26,7 +26,8 @@ import org.osgi.framework.FrameworkUtil;
* This class provides translations. It is a helper class for i18n / localization efforts. * This class provides translations. It is a helper class for i18n / localization efforts.
* *
* @implNote It is implemented as a static singleton, enforced by the single-element enum pattern. * @implNote It is implemented as a static singleton, enforced by the single-element enum pattern.
* @apiNote @set() must be called to provide tanslation service, otherwise all functions will return untranslated text. * @apiNote {@link #setProvider(LocaleProvider, TranslationProvider)} must be called to provide tanslation service,
* otherwise all functions will return untranslated text.
* Thread safety is ensured. * Thread safety is ensured.
* @author Holger Friedrich - Initial contribution * @author Holger Friedrich - Initial contribution
* *
@ -54,7 +55,7 @@ public enum KNXTranslationProvider {
* returns original text with substitutions * returns original text with substitutions
*/ */
public String get(final String text, @Nullable Object @Nullable... arguments) { public String get(final String text, @Nullable Object @Nullable... arguments) {
// ensure thread safety: calls to set(..) should not lead to race condition // ensure thread safety: calls to setProvider(..) should not lead to race condition
final TranslationProvider translationProvider = this.translationProvider; final TranslationProvider translationProvider = this.translationProvider;
final LocaleProvider localeProvider = this.localeProvider; final LocaleProvider localeProvider = this.localeProvider;
if (translationProvider != null) { if (translationProvider != null) {
@ -78,8 +79,8 @@ public enum KNXTranslationProvider {
* get exception in user readable (and possibly localized) form * get exception in user readable (and possibly localized) form
* *
* @param e any exception * @param e any exception
* @return localized message in form <description (translated)> (<class name>, <e.getLocalizedMessage (not * @return localized message in form [description (translated)] [class name], [e.getLocalizedMessage (not
* translated)>), empty string for null. May possibly change in further releases. * translated)]), empty string for null. May possibly change in further releases.
*/ */
public String getLocalizedException(final Throwable e) { public String getLocalizedException(final Throwable e) {
StringBuffer res = new StringBuffer(); StringBuffer res = new StringBuffer();
@ -115,10 +116,10 @@ public enum KNXTranslationProvider {
/** /**
* Set translation providers. To be called to make any translation work. * Set translation providers. To be called to make any translation work.
* *
* @param localeProvider openHAB locale provider, can be generated via \@Activate / \@Reference LocaleProvider in * @param localeProvider openHAB locale provider, can be generated via {@literal @}Activate / {@literal @}Reference
* handler factory * LocaleProvider in handler factory
* @param translationProvider openHAB locale provider, can be generated via \@Activate / \@Reference * @param translationProvider openHAB locale provider, can be generated via {@literal @}Activate /
* TranslationProvider in handler factory * {@literal @}Reference TranslationProvider in handler factory
*/ */
public void setProvider(@Nullable LocaleProvider localeProvider, public void setProvider(@Nullable LocaleProvider localeProvider,
@Nullable TranslationProvider translationProvider) { @Nullable TranslationProvider translationProvider) {