public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc for all addons (#15667)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BaseBluetoothDevice.java
View File

@@ -94,7 +94,7 @@ public abstract class BaseBluetoothDevice extends BluetoothDevice {
* Construct a Bluetooth device taking the Bluetooth address
*
* @param adapter
* @param sender
* @param address
*/
public BaseBluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
super(adapter, address);
@@ -170,7 +170,7 @@ public abstract class BaseBluetoothDevice extends BluetoothDevice {
/**
* Sets the device transmit power
*
* @param power the current transmitter power in dBm
* @param txPower the current transmitter power in dBm
*/
public void setTxPower(int txPower) {
this.txPower = txPower;

4
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothCharacteristic.java
View File

@@ -230,9 +230,7 @@ public class BluetoothCharacteristic {
}
/**
* Get the service to which this characteristic belongs
*
* @return the {@link BluetoothService}
* Set the service to which this characteristic belongs
*/
public void setService(BluetoothService service) {
this.service = service;

6
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/BluetoothDevice.java
View File

@@ -91,7 +91,7 @@ public abstract class BluetoothDevice {
* Construct a Bluetooth device taking the Bluetooth address
*
* @param adapter
* @param sender
* @param address
*/
public BluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
this.address = address;
@@ -175,7 +175,7 @@ public abstract class BluetoothDevice {
/**
* Connects to a device. This is an asynchronous method. Once the connection state is updated, the
* {@link BluetoothDeviceListener.onConnectionState} method will be called with the connection state.
* {@link BluetoothDeviceListener#onConnectionStateChange} method will be called with the connection state.
* <p>
* If the device is already connected, this will return false.
*
@@ -185,7 +185,7 @@ public abstract class BluetoothDevice {
/**
* Disconnects from a device. Once the connection state is updated, the
* {@link BluetoothDeviceListener.onConnectionState}
* {@link BluetoothDeviceListener#onConnectionStateChange}
* method will be called with the connection state.
* <p>
* If the device is not currently connected, this will return false.

12
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDeviceSnapshot.java
View File

@@ -76,7 +76,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* Sets the device transmit power
*
* @param power the current transmitter power in dBm
* @param txPower the current transmitter power in dBm
*/
public void setTxPower(int txPower) {
this.txPower = txPower;
@@ -104,7 +104,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* Set the serial number of the device
*
* @param model a {@link String} defining the serial number
* @param serialNumber a {@link String} defining the serial number
*/
public void setSerialNumberl(String serialNumber) {
this.serialNumber = serialNumber;
@@ -113,7 +113,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* Set the hardware revision of the device
*
* @param model a {@link String} defining the hardware revision
* @param hardwareRevision a {@link String} defining the hardware revision
*/
public void setHardwareRevision(String hardwareRevision) {
this.hardwareRevision = hardwareRevision;
@@ -122,7 +122,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* Set the firmware revision of the device
*
* @param model a {@link String} defining the firmware revision
* @param firmwareRevision a {@link String} defining the firmware revision
*/
public void setFirmwareRevision(String firmwareRevision) {
this.firmwareRevision = firmwareRevision;
@@ -131,7 +131,7 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* Set the software revision of the device
*
* @param model a {@link String} defining the software revision
* @param softwareRevision a {@link String} defining the software revision
*/
public void setSoftwareRevision(String softwareRevision) {
this.softwareRevision = softwareRevision;
@@ -207,8 +207,6 @@ public class BluetoothDeviceSnapshot extends BluetoothDiscoveryDevice {
/**
* This merges non-null identity fields from the given device into this snapshot.
*
* @return true if this snapshot changed as a result of this operation
*/
public void merge(BluetoothDeviceSnapshot device) {
Integer txPower = device.getTxPower();

2
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/discovery/internal/BluetoothDiscoveryProcess.java
View File

@@ -47,7 +47,7 @@ import org.slf4j.LoggerFactory;
/**
* The {@link BluetoothDiscoveryProcess} does the work of creating a DiscoveryResult from a set of
* {@link BluetoothDisocveryParticipant}s
* {@link BluetoothDiscoveryParticipant}s
*
* @author Connor Petty - Initial Contribution
*/

2
bundles/org.openhab.binding.bluetooth/src/main/java/org/openhab/binding/bluetooth/notification/BluetoothScanNotification.java
View File

@@ -131,7 +131,7 @@ public class BluetoothScanNotification extends BluetoothNotification {
/**
* Sets the beacon type for this packet
*
* @beaconType the {@link BluetoothBeaconType} for this packet
* @param beaconType the {@link BluetoothBeaconType} for this packet
*/
public void setBeaconType(BluetoothBeaconType beaconType) {
this.beaconType = beaconType;