Improve javadoc for all addons (#15667)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-09-30 21:49:12 +02:00
committed by GitHub
parent 0039e391cd
commit cbf4411034
618 changed files with 1106 additions and 1110 deletions

View File

@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.command;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* The {@link C_CubeCommand} to request configuration of a new MAX! device after inclusion.
* The {@link CubeCommand} to request configuration of a new MAX! device after inclusion.
*
* @author Marcel Verpaalen - Initial Contribution
*/

View File

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* The {@link F_CubeCommand} is used to query and update the NTP servers used by the Cube.
* The {@link FCommand} is used to query and update the NTP servers used by the Cube.
*
* @author Marcel Verpaalen - Initial Contribution
*/

View File

@@ -15,7 +15,7 @@ package org.openhab.binding.max.internal.command;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* The {@link N_CubeCommand} starts the inclusion mode for new MAX! devices.
* The {@link NCommand} starts the inclusion mode for new MAX! devices.
*
* @author Marcel Verpaalen - Initial Contribution
*/

View File

@@ -21,7 +21,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.binding.max.internal.Utils;
/**
* The {@link T_CubeCommand} is used to unlink MAX! devices from the Cube.
* The {@link TCommand} is used to unlink MAX! devices from the Cube.
*
* @author Marcel Verpaalen - Initial Contribution
*/

View File

@@ -84,7 +84,7 @@ public abstract class Device {
/**
* Creates a new device
*
* @param DeviceConfiguration
* @param c
* @return Device
*/
public static Device create(DeviceConfiguration c) {

View File

@@ -53,7 +53,7 @@ public interface DeviceStatusListener {
/**
* This method is called whenever a device config is updated.
*
* @param bridgeThe MAX! Cube bridge the device was connected to
* @param bridge The MAX! Cube bridge the device was connected to
* @param device The device which config is changed
*/
void onDeviceConfigUpdate(Bridge bridge, Device device);

View File

@@ -927,7 +927,7 @@ public class MaxCubeBridgeHandler extends BaseBridgeHandler {
* Max! Cube, they will be removed from the queue as they would not be
* meaningful. This will improve the behavior when using sliders in the GUI.
*
* @param SendCommand
* @param sendCommand
* the SendCommand containing the serial number of the device as
* String the channelUID used to send the command and the the
* command data
@@ -965,7 +965,7 @@ public class MaxCubeBridgeHandler extends BaseBridgeHandler {
/**
* Delete a devices from the cube and updates the room information
*
* @param Device Serial
* @param maxDeviceSerial Serial
*/
public void sendDeviceDelete(String maxDeviceSerial) {
Device device = getDevice(maxDeviceSerial);

View File

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.slf4j.Logger;
/**
* The {@link: FMessage} contains information about the Cube NTP Configuration
* The {@link FMessage} contains information about the Cube NTP Configuration
* This is the response to a f: command
*
* @author Marcel Verpaalen - Initial contribution
@@ -28,7 +28,7 @@ public final class FMessage extends Message {
private String ntpServer2 = "";
/**
* The {@link: FMessage} contains information about the Cube NTP Configuration
* The {@link FMessage} contains information about the Cube NTP Configuration
*
* @param raw String with raw message
*/

View File

@@ -23,7 +23,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link: NMessage} contains information about a newly discovered Device
* The {@link NMessage} contains information about a newly discovered Device
* This is the response to a n: command
*
* @author Marcel Verpaalen - Initial contribution
@@ -38,7 +38,7 @@ public final class NMessage extends Message {
private String serialnr = "";
/**
* The {@link: NMessage} contains information about a newly discovered Device
* The {@link NMessage} contains information about a newly discovered Device
*
* @param raw String with raw message
*/