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

@@ -58,7 +58,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An extended {@link BluetoothDevice} class to handle BlueGiga specific information
* An extended {@link BaseBluetoothDevice} class to handle BlueGiga specific information
*
* @author Chris Jackson - Initial contribution
*/
@@ -130,7 +130,7 @@ public class BlueGigaBluetoothDevice extends BaseBluetoothDevice implements Blue
};
/**
* Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BluetoothDevice} for the BlueGiga
* Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BaseBluetoothDevice} for the BlueGiga
* implementation
*
* @param bgHandler the {@link BlueGigaBridgeHandler} that provides the link to the dongle

View File

@@ -781,7 +781,6 @@ public class BlueGigaBridgeHandler extends AbstractBluetoothBridgeHandler<BlueGi
public void bluegigaEventReceived(@Nullable BlueGigaResponse event) {
if (event instanceof BlueGigaScanResponseEvent scanEvent) {
if (initComplete) {
// We use the scan event to add any devices we hear to the devices list
// The device gets created, and then manages itself for discovery etc.
BluetoothAddress sender = new BluetoothAddress(scanEvent.getSender());

View File

@@ -142,7 +142,7 @@ public class BlueGigaTransactionManager implements BlueGigaSerialEventListener {
* FIFO queue. This method queues a {@link BlueGigaCommand} frame without
* waiting for a response.
*
* @param transaction
* @param request
* {@link BlueGigaUniqueCommand}
*/
public void queueFrame(BlueGigaUniqueCommand request) {
@@ -245,7 +245,6 @@ public class BlueGigaTransactionManager implements BlueGigaSerialEventListener {
if (bleCommand instanceof BlueGigaDeviceCommand devCommand
&& bleResponse instanceof BlueGigaDeviceResponse devResponse) {
logger.trace("Expected connection id: {}, received connection id: {}", devCommand.getConnection(),
devResponse.getConnection());

View File

@@ -85,7 +85,7 @@ public enum EirDataType {
/**
* Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
*
* @param bluetoothAddressType
* @param eirDataType
* the code to lookup
* @return enumeration value.
*/

View File

@@ -59,7 +59,7 @@ public enum EirFlags {
/**
* Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
*
* @param bluetoothAddressType
* @param eirFlag
* the code to lookup
* @return enumeration value.
*/