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

src/plugins/background-geolocation.ts

@@ -346,12 +346,14 @@ export class BackgroundGeolocation {
   /**
    * Turn ON the background-geolocation system.
    * The user will be tracked whenever they suspend the app.
+   * @returns {Promise<any>}
    */
   @Cordova()
   static start(): Promise<any> { return; }
 
   /**
    * Turn OFF background-tracking
+   * @returns {Promise<any>}
    */
   @Cordova()
   static stop(): Promise<any> { return; }
@@ -372,6 +374,7 @@ export class BackgroundGeolocation {
 
   /**
    * Setup configuration
+   * @returns {Promise<any>}
    */
   @Cordova({
     callbackOrder: 'reverse'
@@ -381,6 +384,7 @@ export class BackgroundGeolocation {
   /**
    * Returns current stationaryLocation if available. null if not
    * NOTE: IOS, WP only
+   * @returns {Promise<Location>}
    */
   @Cordova()
   static getStationaryLocation(): Promise<Location> { return; }
@@ -389,6 +393,7 @@ export class BackgroundGeolocation {
    * Add a stationary-region listener. Whenever the devices enters "stationary-mode",
    * your #success callback will be executed with #location param containing #radius of region
    * NOTE: IOS, WP only
+   * @returns {Promise<any>}
    */
   @Cordova()
   static onStationary(): Promise<any> { return; }
@@ -418,6 +423,7 @@ export class BackgroundGeolocation {
    * If user enable or disable location services then success callback will be executed.
    * In case or error (SettingNotFoundException) fail callback will be executed.
    * NOTE: ANDROID only
+   * @returns {Promise<boolean>}
    */
   @Cordova()
   static watchLocationMode(): Promise<boolean> { return; }
@@ -437,12 +443,14 @@ export class BackgroundGeolocation {
    *  or
    *  - option.debug is true
    * NOTE: ANDROID only
+   * @returns {Promise<any>}
    */
   @Cordova()
   static getLocations(): Promise<any> { return; }
 
   /**

    * Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId.

+   * @returns {Promise<any>}
    */
   @Cordova()
   static getValidLocations(): Promise<any> { return; }
@@ -450,6 +458,7 @@ export class BackgroundGeolocation {
   /**
    * Delete stored location by given locationId.
    * NOTE: ANDROID only
+   * @returns {Promise<any>}
    */
   @Cordova()
   static deleteLocation(locationId: number): Promise<any> { return; }
@@ -457,6 +466,7 @@ export class BackgroundGeolocation {
   /**
    * Delete all stored locations.
    * NOTE: ANDROID only
+   * @returns {Promise<any>}
    */
   @Cordova()
   static deleteAllLocations(): Promise<any> { return; }
@@ -474,6 +484,7 @@ export class BackgroundGeolocation {
    * NOTE: iOS only
    *
    * @param {number} See above.

+   * @returns {Promise<any>}
    */
   @Cordova()
   static switchMode(modeId: number): Promise<any> { return; }
@@ -483,6 +494,7 @@ export class BackgroundGeolocation {
    * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.

    *
    * @param {number} Limits the number of entries

+   * @returns {Promise<any>}
    */
   @Cordova()
   static getLogEntries(limit: number): Promise<any> { return; }