Improve javadoc for all addons (#15667)
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
@@ -54,9 +54,9 @@ public class DeviceFeatureListener {
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param item name of the item that is listening
|
||||
* @param binding
|
||||
* @param channelUID channel associated with this item
|
||||
* @param eventPublisher the publisher to use for publishing on the openhab bus
|
||||
* @param item name of the item that is listening
|
||||
*/
|
||||
public DeviceFeatureListener(InsteonBinding binding, ChannelUID channelUID, String item) {
|
||||
this.binding = binding;
|
||||
|
||||
@@ -328,7 +328,7 @@ public class InsteonDevice {
|
||||
* @param cmd2
|
||||
* @return standard message
|
||||
* @throws FieldException
|
||||
* @throws IOException
|
||||
* @throws InvalidMessageTypeException
|
||||
*/
|
||||
public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2)
|
||||
throws FieldException, InvalidMessageTypeException {
|
||||
@@ -344,7 +344,7 @@ public class InsteonDevice {
|
||||
* @param group (-1 if not a group message)
|
||||
* @return standard message
|
||||
* @throws FieldException
|
||||
* @throws IOException
|
||||
* @throws InvalidMessageTypeException
|
||||
*/
|
||||
public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2, int group)
|
||||
throws FieldException, InvalidMessageTypeException {
|
||||
@@ -381,7 +381,7 @@ public class InsteonDevice {
|
||||
* @param cmd2
|
||||
* @return extended message
|
||||
* @throws FieldException
|
||||
* @throws IOException
|
||||
* @throws InvalidMessageTypeException
|
||||
*/
|
||||
public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2)
|
||||
throws FieldException, InvalidMessageTypeException {
|
||||
@@ -397,7 +397,7 @@ public class InsteonDevice {
|
||||
* @param data array with userdata
|
||||
* @return extended message
|
||||
* @throws FieldException
|
||||
* @throws IOException
|
||||
* @throws InvalidMessageTypeException
|
||||
*/
|
||||
public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2, byte[] data)
|
||||
throws FieldException, InvalidMessageTypeException {
|
||||
@@ -420,7 +420,7 @@ public class InsteonDevice {
|
||||
* @param data array with user data
|
||||
* @return extended message
|
||||
* @throws FieldException
|
||||
* @throws IOException
|
||||
* @throws InvalidMessageTypeException
|
||||
*/
|
||||
public Msg makeExtendedMessageCRC2(byte flags, byte cmd1, byte cmd2, byte[] data)
|
||||
throws FieldException, InvalidMessageTypeException {
|
||||
@@ -503,7 +503,7 @@ public class InsteonDevice {
|
||||
*
|
||||
* @param m message to be sent
|
||||
* @param f device feature that sent this message (so we can associate the response message with it)
|
||||
* @param d time (in milliseconds)to delay before enqueuing message
|
||||
* @param delay time (in milliseconds) to delay before enqueuing message
|
||||
*/
|
||||
public void enqueueDelayedMessage(Msg m, DeviceFeature f, long delay) {
|
||||
long now = System.currentTimeMillis();
|
||||
|
||||
@@ -292,7 +292,7 @@ public abstract class MessageHandler {
|
||||
* Extract button information from message
|
||||
*
|
||||
* @param msg the message to extract from
|
||||
* @param the device feature (needed for debug printing)
|
||||
* @param f the device feature (needed for debug printing)
|
||||
* @return the button number or -1 if no button found
|
||||
*/
|
||||
protected static int getButtonInfo(Msg msg, DeviceFeature f) {
|
||||
|
||||
@@ -324,7 +324,7 @@ public class Msg {
|
||||
* Will fetch a byte array starting at a certain field
|
||||
*
|
||||
* @param key the name of the first field
|
||||
* @param number of bytes to get
|
||||
* @param numBytes of bytes to get
|
||||
* @return the byte array
|
||||
*/
|
||||
public byte[] getBytes(String key, int numBytes) throws FieldException {
|
||||
@@ -369,7 +369,7 @@ public class Msg {
|
||||
/**
|
||||
* Sets the userData fields from a byte array
|
||||
*
|
||||
* @param data
|
||||
* @param arg
|
||||
*/
|
||||
public void setUserData(byte[] arg) {
|
||||
byte[] data = Arrays.copyOf(arg, 14); // appends zeros if short
|
||||
@@ -569,7 +569,7 @@ public class Msg {
|
||||
*
|
||||
* @param type the type of message to create, as defined in the xml file
|
||||
* @return reference to message created
|
||||
* @throws IOException if there is no such message type known
|
||||
* @throws InvalidMessageTypeException if there is no such message type known
|
||||
*/
|
||||
public static Msg makeMessage(String type) throws InvalidMessageTypeException {
|
||||
Msg m = MSG_MAP.get(type);
|
||||
|
||||
Reference in New Issue
Block a user