docs: update some doc strings

capacitor-community · Nov 20, 2021 · 87b0715 · 87b0715
1 parent 4e916af
commit 87b0715
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -559,7 +559,7 @@ createBond(deviceId: string) => Promise<void>
 ```
 
 Create a bond with a peripheral BLE device.
-Only available on Android.
+Only available on **Android**. On iOS bonding is handled by the OS.
 
 | Param          | Type                | Description                                                                                                    |
 | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
@@ -574,7 +574,7 @@ isBonded(deviceId: string) => Promise<boolean>
 ```
 
 Report whether a peripheral BLE device is bonded.
-Only available on Android.
+Only available on **Android**. On iOS bonding is handled by the OS.
 
 | Param          | Type                | Description                                                                                                    |
 | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
@@ -604,7 +604,7 @@ Disconnect from a peripheral BLE device. For an example, see [usage](#usage).
 getServices(deviceId: string) => Promise<BleService[]>
 ```
 
-Get services and characteristics of device.
+Get services, characteristics and descriptors of a device.
 
 | Param          | Type                | Description                                                                                                    |
 | -------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |

diff --git a/src/bleClient.ts b/src/bleClient.ts
@@ -137,14 +137,14 @@ export interface BleClientInterface {
 
   /**
    * Create a bond with a peripheral BLE device.
-   * Only available on Android.
+   * Only available on **Android**. On iOS bonding is handled by the OS.
    * @param deviceId  The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))
    */
   createBond(deviceId: string): Promise<void>;
 
   /**
    * Report whether a peripheral BLE device is bonded.
-   * Only available on Android.
+   * Only available on **Android**. On iOS bonding is handled by the OS.
    * @param deviceId  The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))
    */
   isBonded(deviceId: string): Promise<boolean>;
@@ -156,7 +156,7 @@ export interface BleClientInterface {
   disconnect(deviceId: string): Promise<void>;
 
   /**
-   * Get services and characteristics of device.
+   * Get services, characteristics and descriptors of a device.
    * @param deviceId  The ID of the device to use (obtained from [requestDevice](#requestDevice) or [requestLEScan](#requestLEScan))
    */
   getServices(deviceId: string): Promise<BleService[]>;