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

@@ -21,7 +21,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link MilightBinding} class defines common constants, which are
* The {@link MilightBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author David Graeff - Initial contribution

View File

@@ -221,9 +221,6 @@ public class MilightBridgeDiscovery extends AbstractDiscoveryService implements
/**
* Send a discover message and resends the message until either a valid response
* is received or the resend counter reaches the maximum attempts.
*
* @param scheduler The scheduler is used for resending.
* @throws SocketException
*/
public void startDiscoveryService() {
// Do nothing if there is already a discovery running

View File

@@ -63,8 +63,6 @@ public abstract class AbstractBridgeHandler extends BaseBridgeHandler {
/**
* Creates a connection and other supportive objects.
*
* @param addr
*/
protected abstract void startConnectAndKeepAlive();

View File

@@ -14,7 +14,6 @@ package org.openhab.binding.milight.internal.handler;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.SocketException;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.NonNullByDefault;
@@ -68,10 +67,9 @@ public abstract class AbstractLedHandler extends BaseThingHandler implements Led
/**
* A bulb always belongs to a zone in the milight universe and we need a way to queue commands for being send.
*
* @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset.
* @param thing
* @param sendQueue The send queue.
* @param zone A zone, usually 0 means all bulbs of the same type. [0-4]
* @throws SocketException
* @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset.
*/
public AbstractLedHandler(Thing thing, QueuedSend sendQueue, int typeOffset) {
super(thing);

View File

@@ -44,10 +44,10 @@ import org.slf4j.LoggerFactory;
* with our own client session bytes included.
*
* The response will assign as session bytes that we can use for subsequent commands
* see {@link MilightV6SessionManager#sid1} and see {@link MilightV6SessionManager#sid2}.
* see {@link MilightV6SessionManager#clientSID1} and see {@link MilightV6SessionManager#clientSID2}.
*
* We register ourself to the bridge now and finalise the handshake by sending a register command
* see {@link MilightV6SessionManager#sendRegistration()} to the bridge.
* see {@link #sendRegistration(DatagramSocket)} to the bridge.
*
* From this point on we are required to send keep alive packets to the bridge every ~10sec
* to keep the session alive. Because each command we send is confirmed by the bridge, we know if
@@ -158,10 +158,8 @@ public class MilightV6SessionManager implements Runnable, Closeable {
* A session manager for the V6 bridge needs a way to send data (a QueuedSend object), the destination bridge ID, a
* scheduler for timeout timers and optionally an observer for session state changes.
*
* @param sendQueue A send queue. Never remove or change that object while the session manager is still working.
* @param bridgeId Destination bridge ID. If the bridge ID for whatever reason changes, you need to create a new
* session manager object
* @param scheduler A framework scheduler to create timeout events.
* @param observer Get notifications of state changes
* @param destIP If you know the bridge IP address, provide it here.
* @param port The bridge port