diff --git a/bundles/org.openhab.binding.knx/pom.xml b/bundles/org.openhab.binding.knx/pom.xml index 48d5d2c64..65d508c0e 100644 --- a/bundles/org.openhab.binding.knx/pom.xml +++ b/bundles/org.openhab.binding.knx/pom.xml @@ -57,4 +57,29 @@ + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + + + apiNote + a + API note: + + + implNote + a + Implementation note: + + + + + + + + diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/KNXBindingConstants.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/KNXBindingConstants.java index 5ad2739d3..948aae7c8 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/KNXBindingConstants.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/KNXBindingConstants.java @@ -22,7 +22,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; 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. * * @author Karel Goderis - Initial contribution diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/client/BusMessageListener.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/client/BusMessageListener.java index 1ed9e64aa..37093dba9 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/client/BusMessageListener.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/client/BusMessageListener.java @@ -28,7 +28,8 @@ public interface BusMessageListener { /** * Called when the KNX bridge receives a group write telegram * - * @param bridge + * @param client + * @param source * @param destination * @param asdu */ @@ -37,7 +38,8 @@ public interface BusMessageListener { /** * Called when the KNX bridge receives a group read telegram * - * @param bridge + * @param client + * @param source * @param destination * @param asdu */ @@ -46,7 +48,8 @@ public interface BusMessageListener { /** * Called when the KNX bridge receives a group read response telegram * - * @param bridge + * @param client + * @param source * @param destination * @param asdu */ diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/config/DeviceConfig.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/config/DeviceConfig.java index 99bd46358..5746b6a86 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/config/DeviceConfig.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/config/DeviceConfig.java @@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault; * Configuration object for the device thing handler. * * @author Karel Goderis - Initial contribution - * @author Simon Kaufmann - refactoring & cleanup + * @author Simon Kaufmann - refactoring and cleanup */ @NonNullByDefault public class DeviceConfig { diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/IPBridgeThingHandler.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/IPBridgeThingHandler.java index 77ba219f7..f5aa5d6ec 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/IPBridgeThingHandler.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/IPBridgeThingHandler.java @@ -40,7 +40,7 @@ import tuwien.auto.calimero.secure.KnxSecureException; * directly defined on the bridge * * @author Karel Goderis - Initial contribution - * @author Simon Kaufmann - Refactoring & cleanup + * @author Simon Kaufmann - Refactoring and cleanup */ @NonNullByDefault public class IPBridgeThingHandler extends KNXBridgeBaseThingHandler { diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/SerialBridgeThingHandler.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/SerialBridgeThingHandler.java index 383ab2086..4c598f1fe 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/SerialBridgeThingHandler.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/handler/SerialBridgeThingHandler.java @@ -32,7 +32,7 @@ import org.slf4j.LoggerFactory; * directly defined on the bridge * * @author Karel Goderis - Initial contribution - * @author Simon Kaufmann - Refactoring & cleanup + * @author Simon Kaufmann - Refactoring and cleanup */ @NonNullByDefault public class SerialBridgeThingHandler extends KNXBridgeBaseThingHandler { diff --git a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/i18n/KNXTranslationProvider.java b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/i18n/KNXTranslationProvider.java index 08ebef1b3..c485bd834 100644 --- a/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/i18n/KNXTranslationProvider.java +++ b/bundles/org.openhab.binding.knx/src/main/java/org/openhab/binding/knx/internal/i18n/KNXTranslationProvider.java @@ -26,7 +26,8 @@ import org.osgi.framework.FrameworkUtil; * 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. - * @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. * @author Holger Friedrich - Initial contribution * @@ -54,7 +55,7 @@ public enum KNXTranslationProvider { * returns original text with substitutions */ 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 LocaleProvider localeProvider = this.localeProvider; if (translationProvider != null) { @@ -78,8 +79,8 @@ public enum KNXTranslationProvider { * get exception in user readable (and possibly localized) form * * @param e any exception - * @return localized message in form (, ), empty string for null. May possibly change in further releases. + * @return localized message in form [description (translated)] [class name], [e.getLocalizedMessage (not + * translated)]), empty string for null. May possibly change in further releases. */ public String getLocalizedException(final Throwable e) { StringBuffer res = new StringBuffer(); @@ -115,10 +116,10 @@ public enum KNXTranslationProvider { /** * Set translation providers. To be called to make any translation work. * - * @param localeProvider openHAB locale provider, can be generated via \@Activate / \@Reference LocaleProvider in - * handler factory - * @param translationProvider openHAB locale provider, can be generated via \@Activate / \@Reference - * TranslationProvider in handler factory + * @param localeProvider openHAB locale provider, can be generated via {@literal @}Activate / {@literal @}Reference + * LocaleProvider in handler factory + * @param translationProvider openHAB locale provider, can be generated via {@literal @}Activate / + * {@literal @}Reference TranslationProvider in handler factory */ public void setProvider(@Nullable LocaleProvider localeProvider, @Nullable TranslationProvider translationProvider) {