docs(all): standardizes and adds return types, also some param fixes

This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
+17 -17
View File
@@ -39,7 +39,7 @@ export class BluetoothSerial {
/**
* Connect to a Bluetooth device
* @param {string} macAddress_or_uuid Identifier of the remote device
* @returns {Observable} Subscribe to connect, unsubscribe to disconnect.
* @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'],
@@ -51,7 +51,7 @@ export class BluetoothSerial {
/**
* Connect insecurely to a Bluetooth device
* @param {string} macAddress Identifier of the remote device
* @returns {Observable} Subscribe to connect, unsubscribe to disconnect.
* @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
*/
@Cordova({
platforms: ['Android'],
@@ -63,7 +63,7 @@ export class BluetoothSerial {
/**
* Writes data to the serial port
* @param {any} data ArrayBuffer of data
* @returns {Promise} returns a promise when data has been written
* @returns {Promise<any>} returns a promise when data has been written
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -72,7 +72,7 @@ export class BluetoothSerial {
/**
* Gets the number of bytes of data available
* @returns {Promise} returns a promise that contains the available bytes
* @returns {Promise<any>} returns a promise that contains the available bytes
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -80,7 +80,7 @@ export class BluetoothSerial {
/**
* Reads data from the buffer
* @returns {Promise} returns a promise with data from the buffer
* @returns {Promise<any>} returns a promise with data from the buffer
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -90,7 +90,7 @@ export class BluetoothSerial {
/**
* Reads data from the buffer until it reaches a delimiter
* @param {string} delimiter string that you want to search until
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -100,7 +100,7 @@ export class BluetoothSerial {
/**
* Subscribe to be notified when data is received
* @param {string} delimiter the string you want to watch for
* @returns {Observable} returns an observable.
* @returns {Observable<any>} returns an observable.
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'],
@@ -111,7 +111,7 @@ export class BluetoothSerial {
/**
* Subscribe to be notified when data is received
* @returns {Observable} returns an observable
* @returns {Observable<any>} returns an observable
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'],
@@ -122,7 +122,7 @@ export class BluetoothSerial {
/**
* Clears data in buffer
* @returns {Promise} returns a promise when completed
* @returns {Promise<any>} returns a promise when completed
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -131,7 +131,7 @@ export class BluetoothSerial {
/**
* Lists bonded devices
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -140,7 +140,7 @@ export class BluetoothSerial {
/**
* Reports if bluetooth is enabled
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -149,7 +149,7 @@ export class BluetoothSerial {
/**
* Reports the connection status
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -158,7 +158,7 @@ export class BluetoothSerial {
/**
* Reads the RSSI from the connected peripheral
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -167,7 +167,7 @@ export class BluetoothSerial {
/**
* Show the Bluetooth settings on the device
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -176,7 +176,7 @@ export class BluetoothSerial {
/**
* Enable Bluetooth on the device
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -185,7 +185,7 @@ export class BluetoothSerial {
/**
* Discover unpaired devices
* @returns {Promise} returns a promise
* @returns {Promise<any>} returns a promise
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone']
@@ -194,7 +194,7 @@ export class BluetoothSerial {
/**
* Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function.
* @returns {Observable} Returns an observable
* @returns {Observable<any>} Returns an observable
*/
@Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'],