org.tinyb: API doc: Add @implNote for tinyb.dbus implementation

4 files changed, 22 insertions, 0 deletions

diff --git a/java/org/tinyb/BluetoothAdapter.java b/java/org/tinyb/BluetoothAdapter.java
index e17878f7..39168d87 100644
--- a/java/org/tinyb/BluetoothAdapter.java
+++ b/java/org/tinyb/BluetoothAdapter.java
@@ -72,6 +72,7 @@ public interface BluetoothAdapter extends BluetoothObject
     /**
      * Returns true, if the adapter's device is already whitelisted.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean isDeviceWhitelisted(final String address);
 
@@ -96,6 +97,7 @@ public interface BluetoothAdapter extends BluetoothObject
      *
      * @see #addDeviceToWhitelist(String, BluetoothAddressType, HCIWhitelistConnectType)
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean addDeviceToWhitelist(final String address, final BluetoothAddressType address_type,
                                         final HCIWhitelistConnectType ctype,
@@ -119,6 +121,7 @@ public interface BluetoothAdapter extends BluetoothObject
      *
      * @see #addDeviceToWhitelist(String, BluetoothAddressType, HCIWhitelistConnectType, short, short, short, short)
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean addDeviceToWhitelist(final String address, final BluetoothAddressType address_type,
                                         final HCIWhitelistConnectType ctype);
@@ -127,6 +130,7 @@ public interface BluetoothAdapter extends BluetoothObject
     /**
      * Remove the given device from the adapter's autoconnect whitelist.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean removeDeviceFromWhitelist(final String address, final BluetoothAddressType address_type);
 
@@ -148,6 +152,7 @@ public interface BluetoothAdapter extends BluetoothObject
      * @return TRUE if discovery was successfully enabled
      * @throws BluetoothException
      * @since 2.0.0
+     * @implNote {@code keepAlive} not implemented in tinyb.dbus
      */
     public boolean startDiscovery(final boolean keepAlive) throws BluetoothException;
 
@@ -325,6 +330,7 @@ public interface BluetoothAdapter extends BluetoothObject
      *        {@link AdapterStatusListener} {@code device*} methods. Pass {@code null} for no filtering.
      * @return true if the given listener is not element of the list and has been newly added, otherwise false.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean addStatusListener(final AdapterStatusListener listener, final BluetoothDevice deviceMatch);
 
@@ -333,6 +339,7 @@ public interface BluetoothAdapter extends BluetoothObject
      * @param listener A {@link AdapterStatusListener} instance
      * @return true if the given listener is an element of the list and has been removed, otherwise false.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean removeStatusListener(final AdapterStatusListener l);
 
@@ -340,6 +347,7 @@ public interface BluetoothAdapter extends BluetoothObject
      * Remove all {@link AdapterStatusListener} from the list.
      * @return number of removed listener.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public int removeAllStatusListener();
 
diff --git a/java/org/tinyb/BluetoothDevice.java b/java/org/tinyb/BluetoothDevice.java
index 9a2f85de..0db213f0 100644
--- a/java/org/tinyb/BluetoothDevice.java
+++ b/java/org/tinyb/BluetoothDevice.java
@@ -169,6 +169,7 @@ public interface BluetoothDevice extends BluetoothObject
      *
      * @see BluetoothUtils#getCurrentMilliseconds()
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus, returns {@link #getCreationTimestamp()}
      */
     long getLastDiscoveryTimestamp();
 
@@ -178,6 +179,7 @@ public interface BluetoothDevice extends BluetoothObject
      *
      * @see BluetoothUtils#getCurrentMilliseconds()
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus, returns {@link #getCreationTimestamp()}
      */
     long getLastUpdateTimestamp();
 
@@ -191,6 +193,7 @@ public interface BluetoothDevice extends BluetoothObject
      * determining whether the device is {@link BluetoothAddressType#BDADDR_BREDR}
      * or an LE device, {@link BluetoothAddressType#BDADDR_LE_PUBLIC} or {@link BluetoothAddressType#BDADDR_LE_RANDOM}.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus, returns {@link BluetoothAddressType#BDADDR_LE_PUBLIC}
      */
     BluetoothAddressType getAddressType();
 
@@ -205,6 +208,7 @@ public interface BluetoothDevice extends BluetoothObject
      * method shall return {@link BLERandomAddressType#UNDEFINED}.
      * </p>
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus, returns {@link BLERandomAddressType#UNDEFINED}
      */
     BLERandomAddressType getBLERandomAddressType();
 
@@ -443,6 +447,7 @@ public interface BluetoothDevice extends BluetoothObject
      *        {@link GATTCharacteristicListener} methods. Pass {@code null} for no filtering.
      * @return true if the given listener is not element of the list and has been newly added, otherwise false.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean addCharacteristicListener(final GATTCharacteristicListener listener, final BluetoothGattCharacteristic characteristicMatch);
 
@@ -451,6 +456,7 @@ public interface BluetoothDevice extends BluetoothObject
      * @param listener A {@link GATTCharacteristicListener} instance
      * @return true if the given listener is an element of the list and has been removed, otherwise false.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public boolean removeCharacteristicListener(final GATTCharacteristicListener l);
 
@@ -458,6 +464,7 @@ public interface BluetoothDevice extends BluetoothObject
      * Remove all {@link GATTCharacteristicListener} from the list.
      * @return number of removed listener.
      * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public int removeAllCharacteristicListener();
 }
diff --git a/java/org/tinyb/BluetoothGattService.java b/java/org/tinyb/BluetoothGattService.java
index 0379568b..797a2e82 100644
--- a/java/org/tinyb/BluetoothGattService.java
+++ b/java/org/tinyb/BluetoothGattService.java
@@ -90,6 +90,8 @@ public interface BluetoothGattService extends BluetoothObject
      * Adds the given {@link GATTCharacteristicListener} to the {@link BluetoothDevice} for all {@link BluetoothGattCharacteristic}s.
      * @param listener {@link GATTCharacteristicListener} to add to the {@link BluetoothDevice}.
      * @return true if successful, otherwise false
+     * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public static boolean addCharacteristicListenerToAll(final BluetoothDevice device, final List<BluetoothGattService> services, final GATTCharacteristicListener listener) {
         final boolean res = device.addCharacteristicListener(listener, null /* for all */);
@@ -108,6 +110,8 @@ public interface BluetoothGattService extends BluetoothObject
      * Removes the given {@link GATTCharacteristicListener} from the {@link BluetoothDevice}.
      * @param listener {@link GATTCharacteristicListener} to remove from the {@link BluetoothDevice}.
      * @return true if successful, otherwise false
+     * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public static boolean removeCharacteristicListenerFromAll(final BluetoothDevice device, final List<BluetoothGattService> services, final GATTCharacteristicListener listener) {
         for(final Iterator<BluetoothGattService> is = services.iterator(); is.hasNext(); ) {
@@ -124,6 +128,8 @@ public interface BluetoothGattService extends BluetoothObject
     /**
      * Removes all {@link GATTCharacteristicListener} from the {@link BluetoothDevice}.
      * @return count of removed {@link GATTCharacteristicListener}
+     * @since 2.0.0
+     * @implNote not implemented in tinyb.dbus
      */
     public static int removeAllCharacteristicListener(final BluetoothDevice device, final List<BluetoothGattService> services) {
         for(final Iterator<BluetoothGattService> is = services.iterator(); is.hasNext(); ) {
diff --git a/java/org/tinyb/BluetoothManager.java b/java/org/tinyb/BluetoothManager.java
index 084a69df..0bfc184a 100644
--- a/java/org/tinyb/BluetoothManager.java
+++ b/java/org/tinyb/BluetoothManager.java
@@ -184,6 +184,7 @@ public interface BluetoothManager
      * @return TRUE if discovery was successfully enabled
      * @throws BluetoothException
      * @since 2.0.0
+     * @implNote {@code keepAlive} not implemented in tinyb.dbus
      */
     public boolean startDiscovery(final boolean keepAlive) throws BluetoothException;