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

src/plugins/ibeacon.ts

@@ -140,7 +140,7 @@ export interface Delegate {
   /**
    * An observable that publishes information about the location permission authorization status.
    *
-   * @return Returns a string.
+   * @returns {Observable<string>} Returns a string.
    */
   didChangeAuthorizationStatus(): Observable<string>;
 
@@ -151,7 +151,7 @@ export interface Delegate {
    * This event is called when the phone begins starts monitoring,
    * when requestStateForRegion is called, etc.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   didDetermineStateForRegion(): Observable<PluginResult>;
 
@@ -163,7 +163,7 @@ export interface Delegate {
    *  will be called even when the app is not running on iOS.
    * The app will run silently in the background for a small amount of time.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   didEnterRegion(): Observable<PluginResult>;
 
@@ -175,7 +175,7 @@ export interface Delegate {
    *  will be called even when the app is not running on iOS.
    * The app will run silently in the background for a small amount of time.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   didExitRegion(): Observable<PluginResult>;
 
@@ -184,7 +184,7 @@ export interface Delegate {
    *  each time that the device ranges beacons. Modern Android and iOS devices range
    * aproximately once per second.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   didRangeBeaconsInRegion(): Observable<PluginResult>;
 
@@ -192,7 +192,7 @@ export interface Delegate {
    * An Observable that publishes event data to it's subscribers
    *  when the device begins monitoring a region.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   didStartMonitoringForRegion(): Observable<PluginResult>;
 
@@ -200,7 +200,7 @@ export interface Delegate {
    * An Observable that publishes event data to it's subscribers
    *  when the device fails to monitor a region.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   monitoringDidFailForRegionWithError(): Observable<PluginResult>;
 
@@ -208,7 +208,7 @@ export interface Delegate {
    * An Observable that publishes event data to it's subscribers
    *  when the device begins advertising as an iBeacon.
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   peripheralManagerDidStartAdvertising(): Observable<PluginResult>;
 
@@ -217,7 +217,7 @@ export interface Delegate {
    * when the state of the peripheral manager's state updates.
    *
    *
-   * @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s).
+   * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
    */
   peripheralManagerDidUpdateState(): Observable<PluginResult>;
 }
@@ -380,14 +380,14 @@ export class IBeacon {
    * @param {Number} minor The minor value that you use to identify a specific beacon.
    * @param {BOOL} notifyEntryStateOnDisplay
    *
-   * @return Returns the BeaconRegion that was created
+   * @returns {BeaconRegion} Returns the BeaconRegion that was created
    */
   static BeaconRegion(identifer: string, uuid: string, major?: number, minor?: number, notifyEntryStateOnDisplay?: boolean): BeaconRegion {
     return new cordova.plugins.locationManager.BeaconRegion(identifer, uuid, major, minor, notifyEntryStateOnDisplay);
   }
 
   /**
-   * @return Returns the Delegate
+   * @returns {Delegate} Returns the Delegate
    */
   @Cordova()
   static getDelegate(): Delegate { return; }
@@ -395,7 +395,7 @@ export class IBeacon {
   /**
    * @param {Delegate} delegate An instance of a delegate to register with the native layer.
    *
-   * @return Returns the Delegate
+   * @returns {Delegate} Returns the Delegate
    */
   @Cordova()
   static setDelegate(delegate: Delegate): Delegate { return; }
@@ -417,7 +417,7 @@ export class IBeacon {
    * message get emitted in the native runtime and the DOM as well after a certain
    * period of time.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the request and started to send events.
    */
   @Cordova({otherPromise: true})
@@ -425,7 +425,7 @@ export class IBeacon {
 
   /**
    * Determines if bluetooth is switched on, according to the native layer.
-   * @returns Returns a promise which is resolved with a {Boolean}
+   * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
    * indicating whether bluetooth is active.
    */
   @Cordova({otherPromise: true})
@@ -434,7 +434,7 @@ export class IBeacon {
   /**
    * Enables Bluetooth using the native Layer. (ANDROID ONLY)
    *
-   * @returns Returns a promise which is resolved when Bluetooth
+   * @returns {Promise<void>} Returns a promise which is resolved when Bluetooth
    * could be enabled. If not, the promise will be rejected with an error.
    */
   @Cordova({otherPromise: true})
@@ -443,7 +443,7 @@ export class IBeacon {
   /**
    * Disables Bluetooth using the native Layer. (ANDROID ONLY)
    *
-   * @returns Returns a promise which is resolved when Bluetooth
+   * @returns {Promise<void>} Returns a promise which is resolved when Bluetooth
    * could be enabled. If not, the promise will be rejected with an error.
    */
   @Cordova({otherPromise: true})
@@ -463,7 +463,7 @@ export class IBeacon {
    * @param {Region} region An instance of {Region} which will be monitored
    * by the operating system.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<string>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the monitoring request.
    */
   @Cordova({otherPromise: true})
@@ -480,7 +480,7 @@ export class IBeacon {
    * @param {Region} region An instance of {Region} which will be monitored
    * by the operating system.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the request to stop monitoring.
    */
   @Cordova({otherPromise: true})
@@ -496,7 +496,7 @@ export class IBeacon {
    * @param {Region} region An instance of {Region} which will be monitored
    * by the operating system.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the request to stop monitoring.
    */
   @Cordova({otherPromise: true})
@@ -514,7 +514,7 @@ export class IBeacon {
    * @param {Region} region An instance of {BeaconRegion} which will be monitored
    * by the operating system.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the monitoring request.
    */
   @Cordova({otherPromise: true})
@@ -531,7 +531,7 @@ export class IBeacon {
    * @param {Region} region An instance of {BeaconRegion} which will be monitored
    * by the operating system.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the request to stop monitoring.
    */
   @Cordova({otherPromise: true})
@@ -540,7 +540,7 @@ export class IBeacon {
   /**
    * Queries the native layer to determine the current authorization in effect.
    *
-   * @returns Returns a promise which is resolved with the
+   * @returns {Promise<any>} Returns a promise which is resolved with the
    * requested authorization status.
    */
   @Cordova({otherPromise: true})
@@ -553,7 +553,7 @@ export class IBeacon {
    * <a href="https://developer.apple.com/library/prerelease/iOS/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html#//apple_ref/occ/instm/CLLocationManager/requestAlwaysAuthorization">requestAlwaysAuthorization</a>
    *
    * If you are using this plugin on Android devices only, you will never have to use this, nor {@code requestAlwaysAuthorization}
-   * @returns Returns a promise that is resolved when the request dialog is shown.
+   * @returns {Promise<void>} Returns a promise that is resolved when the request dialog is shown.
    */
   @Cordova({otherPromise: true})
   static requestWhenInUseAuthorization(): Promise<void> { return; }
@@ -562,7 +562,7 @@ export class IBeacon {
   /**
    * See the docuemntation of {@code requestWhenInUseAuthorization} for further details.
    *
-   * @returns Returns a promise which is resolved when the native layer
+   * @returns {Promise<void>} Returns a promise which is resolved when the native layer
    * shows the request dialog.
    */
   @Cordova({otherPromise: true})
@@ -570,7 +570,7 @@ export class IBeacon {
 
   /**
    *
-   * @returns Returns a promise which is resolved with an {Array}
+   * @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array}
    * of {Region} instances that are being monitored by the native layer.
    */
   @Cordova({otherPromise: true})
@@ -578,7 +578,7 @@ export class IBeacon {
 
   /**
    *
-   * @returns Returns a promise which is resolved with an {Array}
+   * @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array}
    * of {Region} instances that are being ranged by the native layer.
    */
   @Cordova({otherPromise: true})
@@ -586,7 +586,7 @@ export class IBeacon {
 
   /**
    * Determines if ranging is available or not, according to the native layer.
-   * @returns Returns a promise which is resolved with a {Boolean}
+   * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
    * indicating whether ranging is available or not.
    */
   @Cordova({otherPromise: true})
@@ -598,7 +598,7 @@ export class IBeacon {
    * @param {Region} region An instance of {Region} which will be checked
    * by the operating system.
    *
-   * @returns Returns a promise which is resolved with a {Boolean}
+   * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
    * indicating whether the region type is supported or not.
    */
   @Cordova({otherPromise: true})
@@ -618,7 +618,7 @@ export class IBeacon {
    * @param {Integer} measuredPower: Optional parameter, if left empty, the device will
    * use it's own default value.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the advertising request.
    */
   @Cordova({otherPromise: true})
@@ -629,7 +629,7 @@ export class IBeacon {
    *
    * This is done asynchronously and may not be immediately reflected in isAdvertising.
    *
-   * @return Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer acknowledged the dispatch of the request to stop advertising.
    */
   @Cordova({otherPromise: true})
@@ -637,7 +637,7 @@ export class IBeacon {
 
   /**
    * Determines if advertising is available or not, according to the native layer.
-   * @returns Returns a promise which is resolved with a {Boolean}
+   * @returns {Promise<void>} Returns a promise which is resolved with a {Boolean}
    * indicating whether advertising is available or not.
    */
   @Cordova({otherPromise: true})
@@ -645,7 +645,7 @@ export class IBeacon {
 
   /**
    * Determines if advertising is currently active, according to the native layer.
-   * @returns Returns a promise which is resolved with a {Boolean}
+   * @returns {Promise<void>} Returns a promise which is resolved with a {Boolean}
    * indicating whether advertising is active.
    */
   @Cordova({otherPromise: true})
@@ -655,7 +655,7 @@ export class IBeacon {
    * Disables debug logging in the native layer. Use this method if you want
    * to prevent this plugin from writing to the device logs.
    *
-   * @returns Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer has set the logging level accordingly.
    */
   @Cordova({otherPromise: true})
@@ -666,7 +666,7 @@ export class IBeacon {
    * to allow the plugin the posting local notifications.
    * This can be very helpful when debugging how to apps behave when launched into the background.
    *
-   * @returns Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer has set the flag to enabled.
    */
   @Cordova({otherPromise: true})
@@ -676,7 +676,7 @@ export class IBeacon {
    * Disables the posting of debug notifications in the native layer. Use this method if you want
    * to prevent the plugin from posting local notifications.
    *
-   * @returns Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer has set the flag to disabled.
    */
   @Cordova({otherPromise: true})
@@ -686,7 +686,7 @@ export class IBeacon {
    * Enables debug logging in the native layer. Use this method if you want
    * a debug the inner workings of this plugin.
    *
-   * @returns Returns a promise which is resolved as soon as the
+   * @returns {Promise<void>} Returns a promise which is resolved as soon as the
    * native layer has set the logging level accordingly.
    */
   @Cordova({otherPromise: true})
@@ -698,7 +698,7 @@ export class IBeacon {
    *
    * @param {String} message The message to append to the device logs.
    *
-   * @returns Returns a promise which is resolved with the log
+   * @returns {Promise<void>} Returns a promise which is resolved with the log
    * message received by the native layer for appending. The returned message
    * is expected to be equivalent to the one provided in the original call.
    */