diff options
author | Sven Gothel <[email protected]> | 2020-05-28 06:03:50 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2020-05-28 06:03:50 +0200 |
commit | 1da27ac4831a6ae64e059ec29eb186e653a1a4e5 (patch) | |
tree | 9d4b3c76b276c2b4b1517916c34e8a28815cae7b /java | |
parent | 6cfc5d73381df060cbadbef1122f3bf16d5f52dc (diff) |
AdapterStatusListener java/C++: Add API doc
Diffstat (limited to 'java')
-rw-r--r-- | java/org/tinyb/AdapterStatusListener.java | 33 |
1 files changed, 27 insertions, 6 deletions
diff --git a/java/org/tinyb/AdapterStatusListener.java b/java/org/tinyb/AdapterStatusListener.java index d5d1c128..73a9d52c 100644 --- a/java/org/tinyb/AdapterStatusListener.java +++ b/java/org/tinyb/AdapterStatusListener.java @@ -51,26 +51,47 @@ public abstract class AdapterStatusListener { @SuppressWarnings("unused") private long nativeInstance; - /** A {@link BluetoothAdapter} setting has been changed. */ + /** + * {@link BluetoothAdapter} setting(s) changed. + * @param adapter the adapter which settings have changed. + * @param oldmask the previous settings mask + * @param newmask the new settings mask + * @param changedmask the changes settings mask + * @param timestamp the time in monotonic milliseconds when this event occurred. See {@link BluetoothUtils#getCurrentMilliseconds()}. + */ public void adapterSettingsChanged(final BluetoothAdapter adapter, final AdapterSettings oldmask, final AdapterSettings newmask, final AdapterSettings changedmask, final long timestamp) { } /** * {@link BluetoothAdapter}'s discovery state has changed, i.e. enabled or disabled. - * @param adapter the adapter which state has changed. + * @param adapter the adapter which discovering state has changed. * @param enabled the new discovery state * @param keepAlive if {@code true}, the discovery will be re-enabled if disabled by the underlying Bluetooth implementation. - * @param timestamp the time in monotonic milliseconds when this event occured. + * @param timestamp the time in monotonic milliseconds when this event occurred. See {@link BluetoothUtils#getCurrentMilliseconds()}. */ public void discoveringChanged(final BluetoothAdapter adapter, final boolean enabled, final boolean keepAlive, final long timestamp) { } - /** A {@link BluetoothDevice} has been newly discovered. */ + /** + * A {@link BluetoothDevice} has been newly discovered. + * @param device the found device + * @param timestamp the time in monotonic milliseconds when this event occurred. See {@link BluetoothUtils#getCurrentMilliseconds()}. + */ public void deviceFound(final BluetoothDevice device, final long timestamp) { } - /** An already discovered {@link BluetoothDevice} has been updated. */ + /** + * An already discovered {@link BluetoothDevice} has been updated. + * @param device the updated device + * @param timestamp the time in monotonic milliseconds when this event occurred. See {@link BluetoothUtils#getCurrentMilliseconds()}. + * @param updateMask the update mask of changed data + */ public void deviceUpdated(final BluetoothDevice device, final long timestamp, final EIRDataTypeSet updateMask) { } - /** {@link BluetoothDevice}'s connection status has changed. */ + /** + * {@link BluetoothDevice}'s connection status has changed. + * @param device the device which connection state has changed + * @param connected if {@code true} the device has been connected, otherwise disconnected + * @param timestamp the time in monotonic milliseconds when this event occurred. See {@link BluetoothUtils#getCurrentMilliseconds()}. + */ public void deviceConnectionChanged(final BluetoothDevice device, final boolean connected, final long timestamp) { } }; |