[knx] Fix javadoc errors (#14174)
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
GitHub
parent
649da669ac
commit
0f272d8523
|
|
@ -57,4 +57,29 @@
|
|||
</dependency>
|
||||
</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>
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
|
|
|||
|
|
@ -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 {
|
||||
|
|
|
|||
|
|
@ -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 <description (translated)> (<class name>, <e.getLocalizedMessage (not
|
||||
* translated)>), 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) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue