From 7cbe7a628729ec86730827b91ad4073a6a89fc29 Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 8 Apr 2018 19:09:43 +0200 Subject: [PATCH] docs(ble): add missing documentations --- src/@ionic-native/plugins/ble/index.ts | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/@ionic-native/plugins/ble/index.ts b/src/@ionic-native/plugins/ble/index.ts index 497ddd1ec..d108e2df4 100644 --- a/src/@ionic-native/plugins/ble/index.ts +++ b/src/@ionic-native/plugins/ble/index.ts @@ -232,7 +232,7 @@ export class BLE extends IonicNativePlugin { /** * Scans for BLE devices. This function operates similarly to the `startScan` function, but allows you to specify extra options (like allowing duplicate device reports). * @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices - * @param options {any} + * @param {BLEScanOptions} options Options * @returns {Observable} Returns an Observable that notifies of each peripheral discovered. */ @Cordova({ @@ -259,7 +259,7 @@ export class BLE extends IonicNativePlugin { * BLE.stopScan().then(() => { console.log('scan stopped'); }); * }, 5000); * ``` - * @return returns a Promise. + * @returns {Promise} */ @Cordova() stopScan(): Promise { @@ -277,8 +277,8 @@ export class BLE extends IonicNativePlugin { * console.log('disconnected'); * }); * ``` - * @param deviceId {string} UUID or MAC address of the peripheral - * @return Returns an Observable that notifies of connect/disconnect. + * @param {string} deviceId UUID or MAC address of the peripheral + * @return {Observable} Returns an Observable that notifies of connect/disconnect. */ @Cordova({ observable: true, @@ -297,8 +297,8 @@ export class BLE extends IonicNativePlugin { * console.log('Disconnected'); * }); * ``` - * @param deviceId {string} UUID or MAC address of the peripheral - * @return Returns a Promise + * @param {string} deviceId UUID or MAC address of the peripheral + * @return {Promise} Returns a Promise */ @Cordova() disconnect(deviceId: string): Promise { @@ -311,7 +311,7 @@ export class BLE extends IonicNativePlugin { * @param {string} deviceId UUID or MAC address of the peripheral * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic - * @return Returns a Promise + * @return {Promise} Returns a Promise */ @Cordova() read( @@ -348,7 +348,7 @@ export class BLE extends IonicNativePlugin { * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic * @param {ArrayBuffer} value Data to write to the characteristic, as an ArrayBuffer. - * @return Returns a Promise + * @return {Promise} Returns a Promise */ @Cordova() write( @@ -367,7 +367,7 @@ export class BLE extends IonicNativePlugin { * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic * @param {ArrayBuffer} value Data to write to the characteristic, as an ArrayBuffer. - * @return Returns a Promise + * @return {Promise} Returns a Promise */ @Cordova() writeWithoutResponse( @@ -392,7 +392,7 @@ export class BLE extends IonicNativePlugin { * @param {string} deviceId UUID or MAC address of the peripheral * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic - * @return Returns an Observable that notifies of characteristic changes. + * @return {Observable} Returns an Observable that notifies of characteristic changes. */ @Cordova({ observable: true, @@ -462,7 +462,7 @@ export class BLE extends IonicNativePlugin { * }); * ``` * - * @return Returns an Observable that notifies when the Bluetooth is enabled or disabled on the device. + * @return {Observable} Returns an Observable that notifies when the Bluetooth is enabled or disabled on the device. */ @Cordova({ observable: true, @@ -508,7 +508,7 @@ export class BLE extends IonicNativePlugin { * * @param {string} deviceId UUID or MAC address of the peripheral * - *@returns {Promise} + * @returns {Promise} */ @Cordova() readRSSI(deviceId: string): Promise {