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

@@ -66,7 +66,7 @@ public class BPUPListener implements Runnable {
/**
* Constructor of the receiver runnable thread.
*
* @param address The address of the Bond Bridge
* @param bridgeHandler The handler of the Bond Bridge
* @throws SocketException is some problem occurs opening the socket.
*/
public BPUPListener(BondBridgeHandler bridgeHandler) {

View File

@@ -169,7 +169,7 @@ public class BondHttpApi {
* Executes a device action
*
* @param deviceId The ID of the device
* @param actionId The Bond action
* @param action The Bond action
* @param argument An additional argument for the actions (such as the fan speed)
*/
public synchronized void executeDeviceAction(String deviceId, BondDeviceAction action, @Nullable Integer argument) {

View File

@@ -16,7 +16,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* The {@link BondHomeConfiguration} class contains fields mapping thing configuration parameters.
* The {@link BondDeviceConfiguration} class contains fields mapping thing configuration parameters.
*
* @author Sara Geleskie Damiano - Initial contribution
*/

View File

@@ -198,7 +198,7 @@ public class BondBridgeHandler extends BaseBridgeHandler {
/**
* Forwards a push update to a device
*
* @param the {@link BPUPUpdate object}
* @param pushUpdate the {@link BPUPUpdate object}
*/
public void forwardUpdateToThing(BPUPUpdate pushUpdate) {
updateStatus(ThingStatus.ONLINE);