Improve javadoc for all addons (#15667)
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
@@ -19,7 +19,7 @@ import java.util.stream.Stream;
|
||||
import org.openhab.core.thing.ThingTypeUID;
|
||||
|
||||
/**
|
||||
* The {@link LIRCBinding} class defines common constants, which are
|
||||
* The {@link LIRCBindingConstants} class defines common constants, which are
|
||||
* used across the whole binding.
|
||||
*
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
|
||||
@@ -19,7 +19,7 @@ import org.openhab.core.thing.ThingUID;
|
||||
/**
|
||||
* Interface for listeners to receive messages from LIRC server
|
||||
*
|
||||
* @author Andrew Nagle
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
public interface LIRCMessageListener {
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ package org.openhab.binding.lirc.internal;
|
||||
/**
|
||||
* Exceptions thrown from the serial interface.
|
||||
*
|
||||
* @author Andrew Nagle - Initial contributor
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
public class LIRCResponseException extends Exception {
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package org.openhab.binding.lirc.internal.config;
|
||||
|
||||
/**
|
||||
* Configuration class for {@link LIRCBridge} device.
|
||||
* Configuration class for LIRCBridge device.
|
||||
*
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
package org.openhab.binding.lirc.internal.config;
|
||||
|
||||
/**
|
||||
* Configuration class for {@link LIRCRemote} device.
|
||||
* Configuration class for LIRCRemote device.
|
||||
*
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
|
||||
@@ -30,7 +30,7 @@ import org.slf4j.LoggerFactory;
|
||||
/**
|
||||
* Connector for communication with the LIRC server
|
||||
*
|
||||
* @author Andrew Nagle - Initial contributor
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
public class LIRCConnector {
|
||||
|
||||
|
||||
@@ -18,14 +18,14 @@ import org.openhab.binding.lirc.internal.messages.LIRCResponse;
|
||||
/**
|
||||
* Defines an interface to receive messages from the LIRC server
|
||||
*
|
||||
* @author Andrew Nagle
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
public interface LIRCEventListener {
|
||||
|
||||
/**
|
||||
* Procedure to receive messages from the LIRC server
|
||||
*
|
||||
* @param reponse
|
||||
* @param message
|
||||
* Message received
|
||||
*/
|
||||
void messageReceived(LIRCResponse message);
|
||||
|
||||
@@ -31,7 +31,7 @@ import org.slf4j.LoggerFactory;
|
||||
/**
|
||||
* Stream reader to parse LIRC output into messages
|
||||
*
|
||||
* @author Andrew Nagle
|
||||
* @author Andrew Nagle - Initial contribution
|
||||
*/
|
||||
public class LIRCStreamReader extends Thread {
|
||||
|
||||
|
||||
Reference in New Issue
Block a user