Improve javadoc for some addons (#15701)
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
GitHub
@@ -19,7 +19,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
|
||||
/**
|
||||
* Utility class for common tasks within the MAX! binding package.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -30,7 +30,7 @@ import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* The {@link MCommand} Creates the MAX! Cube the room & device name information update message.
|
||||
* The {@link MCommand} Creates the MAX! Cube the room and device name information update message.
|
||||
*
|
||||
* @author Marcel Verpaalen - Initial Contribution
|
||||
*/
|
||||
|
||||
@@ -19,9 +19,9 @@ import org.openhab.binding.max.internal.Utils;
|
||||
import org.openhab.binding.max.internal.device.ThermostatModeType;
|
||||
|
||||
/**
|
||||
* {@link SCommand} for setting MAX! thermostat temperature & mode.
|
||||
* {@link SCommand} for setting MAX! thermostat temperature and mode.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update + simplification
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -27,7 +27,8 @@ public class MaxCubeBridgeConfiguration {
|
||||
|
||||
/**
|
||||
* The port of the MAX! Cube LAN gateway as provided at
|
||||
* http://www.elv.de/controller.aspx?cid=824&detail=10&detail2=3484
|
||||
* <a href="http://www.elv.de/controller.aspx?cid=824&detail=10&detail2=3484">
|
||||
* http://www.elv.de/controller.aspx?cid=824&detail=10&detail2=3484</a>
|
||||
*/
|
||||
public Integer port;
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ import org.slf4j.LoggerFactory;
|
||||
/**
|
||||
* Base class for devices provided by the MAX! protocol.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update + enhancements
|
||||
*/
|
||||
public abstract class Device {
|
||||
|
||||
@@ -21,7 +21,7 @@ import org.openhab.binding.max.internal.message.Message;
|
||||
/**
|
||||
* Base class for configuration provided by the MAX! Cube C Message.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
public final class DeviceConfiguration {
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device;
|
||||
/**
|
||||
* Device information provided by the M message meta information.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
public class DeviceInformation {
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device;
|
||||
/**
|
||||
* This enumeration represents the different message types provided by the MAX! Cube protocol.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
public enum DeviceType {
|
||||
Invalid(256),
|
||||
|
||||
@@ -18,9 +18,9 @@ import java.util.Calendar;
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* MAX! Heating thermostat & Heating thermostat+ .
|
||||
* MAX! Heating thermostat and Heating thermostat+ .
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*/
|
||||
public class HeatingThermostat extends Device {
|
||||
|
||||
@@ -15,8 +15,8 @@ package org.openhab.binding.max.internal.device;
|
||||
/**
|
||||
* Room information provided by the M message meta information.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Marcel Verpaalen (marcel@verpaalen.com) - OH2 update
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*/
|
||||
public class RoomInformation {
|
||||
private int position;
|
||||
|
||||
@@ -17,7 +17,7 @@ import org.openhab.core.library.types.OpenClosedType;
|
||||
/**
|
||||
* MAX! Shutter contact device.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*/
|
||||
public class ShutterContact extends Device {
|
||||
|
||||
@@ -19,7 +19,7 @@ import org.openhab.core.types.State;
|
||||
/**
|
||||
* This enumeration represents the different mode types of a MAX! heating thermostat.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*/
|
||||
public enum ThermostatModeType implements PrimitiveType, State, Command {
|
||||
|
||||
@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device;
|
||||
/**
|
||||
* Unsupported devices.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*/
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.device;
|
||||
/**
|
||||
* MAX! wall mounted thermostat.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
public class WallMountedThermostat extends HeatingThermostat {
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* Will be thrown when there is an attempt to put a new message line into the message processor,
|
||||
* but the processor is currently processing another message type.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class IncompleteMessageException extends Exception {
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* Will be thrown when there is an attempt to put a new message line into the message processor,
|
||||
* but the processor is currently processing another message type.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class IncorrectMultilineIndexException extends Exception {
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* but the processor is not yet ready to handle new lines because there is already a message that
|
||||
* has be pulled before.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class MessageIsWaitingException extends Exception {
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* Will be thrown when there is an attempt to pull a message from the message processor,
|
||||
* but the processor does not yet have a complete message.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class NoMessageAvailableException extends Exception {
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* Will be thrown when there is an attempt to put a new message line into the message processor,
|
||||
* the processor detects a known message indicator, but the message could not be parsed correctly.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class UnprocessableMessageException extends Exception {
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ package org.openhab.binding.max.internal.exceptions;
|
||||
* Will be thrown when there is an attempt to put a new message line into the message processor,
|
||||
* but the line starts with an unknown message indicator.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
public class UnsupportedMessageTypeException extends Exception {
|
||||
|
||||
|
||||
@@ -105,7 +105,7 @@ import org.slf4j.LoggerFactory;
|
||||
* to the framework. All {@link MaxDevicesHandler}s use the
|
||||
* {@link MaxCubeBridgeHandler} to execute the actual commands.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - Initial contribution OH2 version
|
||||
* @author Bernd Michael Helm (bernd.helm at helmundwalter.de) - Exclusive mode
|
||||
*/
|
||||
|
||||
@@ -35,7 +35,7 @@ import org.slf4j.LoggerFactory;
|
||||
/**
|
||||
* The {@link CMessage} contains configuration about a MAX! device.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - Detailed parsing, OH2 Update
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -25,7 +25,7 @@ import org.slf4j.Logger;
|
||||
/**
|
||||
* The H message contains information about the MAX! Cube.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - Details parsing, OH2 version
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -27,7 +27,7 @@ import org.slf4j.Logger;
|
||||
/**
|
||||
* The L message contains real time information about all MAX! devices.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 update
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -28,7 +28,7 @@ import org.slf4j.LoggerFactory;
|
||||
/**
|
||||
* The M message contains metadata about the MAX! Cube setup.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial Contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - Room details parse
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -24,7 +24,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
|
||||
* The tokens returned consist of the payload solely, and do not contain the first byte holding the
|
||||
* tokens length.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
@NonNullByDefault
|
||||
public final class MaxTokenizer implements Enumeration<byte[]> {
|
||||
|
||||
@@ -18,7 +18,7 @@ import org.slf4j.Logger;
|
||||
/**
|
||||
* Base message for the messages received from the MAX! Cube.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
@NonNullByDefault
|
||||
public abstract class Message {
|
||||
|
||||
@@ -33,7 +33,7 @@ import org.openhab.binding.max.internal.exceptions.UnsupportedMessageTypeExcepti
|
||||
* possible to add additional lines when there is a message ready to be
|
||||
* processed.
|
||||
*
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
@NonNullByDefault
|
||||
public class MessageProcessor {
|
||||
|
||||
@@ -17,7 +17,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
|
||||
/**
|
||||
* This enumeration represents the different message types provided by the MAX! Cube protocol.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
*/
|
||||
@NonNullByDefault
|
||||
public enum MessageType {
|
||||
|
||||
@@ -21,7 +21,7 @@ import org.openhab.binding.max.internal.device.DeviceType;
|
||||
/**
|
||||
* Tests cases for {@link CMessage}.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 Version and updates
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -24,7 +24,7 @@ import org.openhab.binding.max.internal.device.DeviceType;
|
||||
/**
|
||||
* Tests cases for {@link DeviceConfiguration}.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 Version and updates
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
@@ -24,7 +24,7 @@ import org.openhab.binding.max.internal.exceptions.UnprocessableMessageException
|
||||
import org.openhab.binding.max.internal.exceptions.UnsupportedMessageTypeException;
|
||||
|
||||
/**
|
||||
* @author Christian Rockrohr <christian@rockrohr.de> - Initial contribution
|
||||
* @author Christian Rockrohr - Initial contribution
|
||||
*/
|
||||
@NonNullByDefault
|
||||
public class MessageProcessorTest {
|
||||
|
||||
@@ -23,7 +23,7 @@ import org.openhab.binding.max.internal.Utils;
|
||||
/**
|
||||
* Tests cases for {@link Utils}.
|
||||
*
|
||||
* @author Andreas Heil (info@aheil.de) - Initial contribution
|
||||
* @author Andreas Heil - Initial contribution
|
||||
* @author Marcel Verpaalen - OH2 Version and updates
|
||||
*/
|
||||
@NonNullByDefault
|
||||
|
||||
Reference in New Issue
Block a user