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

src/plugins/hotspot.ts

@@ -23,9 +23,15 @@ import { Cordova, Plugin } from './plugin';
 })
 export class Hotspot {
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isAvailable(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static toggleWifi(): Promise<boolean> { return; }
 
@@ -36,7 +42,7 @@ export class Hotspot {
    * @param {string}    mode        - encryption mode (Open, WEP, WPA, WPA_PSK)
    * @param {string}    password    - password for your new Access Point
    *
-   * @return {Promise<void>}        - Promise to call once hotspot is started, or reject upon failure
+   * @returns {Promise<void>}        - Promise to call once hotspot is started, or reject upon failure
    */
   @Cordova()
   static createHotspot(ssid: string, mode: string, password: string): Promise<void> { return; }
@@ -44,7 +50,7 @@ export class Hotspot {
   /**
    * Turns on Access Point
    *
-   * @return {Promise<boolean>} - true if AP is started
+   * @returns {Promise<boolean>} - true if AP is started
    */
   @Cordova()
   static startHotspot(): Promise<boolean> { return; }
@@ -56,7 +62,7 @@ export class Hotspot {
    * @param {string}    mode        - encryption mode (Open, WEP, WPA, WPA_PSK)
    * @param {string}    password    - password for your new Access Point
    *
-   * @return {Promise<void>}        - Promise to call when hotspot is configured, or reject upon failure
+   * @returns {Promise<void>}        - Promise to call when hotspot is configured, or reject upon failure
    */
   @Cordova()
   static configureHotspot(ssid: string, mode: string, password: string): Promise<void> { return; }
@@ -64,7 +70,7 @@ export class Hotspot {
   /**
    * Turns off Access Point
    *
-   * @return {Promise<boolean>} - Promise to turn off the hotspot, true on success, false on failure
+   * @returns {Promise<boolean>} - Promise to turn off the hotspot, true on success, false on failure
    */
   @Cordova()
   static stopHotspot(): Promise<boolean> { return; }
@@ -72,11 +78,14 @@ export class Hotspot {
   /**
    * Checks if hotspot is enabled
    *
-   * @return {Promise<void>}    - Promise that hotspot is enabled, rejected if it is not enabled
+   * @returns {Promise<void>}    - Promise that hotspot is enabled, rejected if it is not enabled
    */
   @Cordova()
   static isHotspotEnabled(): Promise<void> { return; }
 
+  /**
+   * @returns {Promise<Array<HotspotDevice>>}
+   */
   @Cordova()
   static getAllHotspotDevices(): Promise<Array<HotspotDevice>> { return; }
 
@@ -88,7 +97,7 @@ export class Hotspot {
    * @param {string}    password
    *      password to use
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    *      Promise that connection to the WiFi network was successfull, rejected if unsuccessful
    */
   @Cordova()
@@ -106,7 +115,7 @@ export class Hotspot {
    * @param {string[]} encryption
    *      Encryption modes to use (CCMP, TKIP, WEP104, WEP40)
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    *      Promise that connection to the WiFi network was successfull, rejected if unsuccessful
    */
   @Cordova()
@@ -122,7 +131,7 @@ export class Hotspot {
    * @param {string}    password
    *      Password for network
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    *      Promise that adding the WiFi network was successfull, rejected if unsuccessful
    */
   @Cordova()
@@ -134,45 +143,81 @@ export class Hotspot {
    * @param {string}    ssid
    *      SSID of network
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    *      Promise that removing the WiFi network was successfull, rejected if unsuccessful
    */
   @Cordova()
   static removeWifiNetwork(ssid: string): Promise<void> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isConnectedToInternet(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isConnectedToInternetViaWifi(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isWifiOn(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isWifiSupported(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<boolean>}
+   */
   @Cordova()
   static isWifiDirectSupported(): Promise<boolean> { return; }
 
+  /**
+   * @returns {Promise<Array<HotspotNetwork>>}
+   */
   @Cordova()
   static scanWifi(): Promise<Array<HotspotNetwork>> { return; }
 
+  /**
+   * @returns {Promise<Array<HotspotNetwork>>}
+   */
   @Cordova()
   static scanWifiByLevel(): Promise<Array<HotspotNetwork>> { return; }
 
+  /**
+   * @returns {Promise<any>}
+   */
   @Cordova()
   static startWifiPeriodicallyScan(interval: number, duration: number): Promise<any> { return; }
 
+  /**
+   * @returns {Promise<any>}
+   */
   @Cordova()
   static stopWifiPeriodicallyScan(): Promise<any> { return; }
 
+  /**
+   * @returns {Promise<HotspotNetworkConfig>}
+   */
   @Cordova()
   static getNetConfig(): Promise<HotspotNetworkConfig> { return; }
 
+  /**
+   * @returns {Promise<ConnectionInfo>}
+   */
   @Cordova()
   static getConnectionInfo(): Promise<ConnectionInfo> { return; }
 
+  /**
+   * @returns {Promise<string>}
+   */
   @Cordova()
   static pingHost(ip: string): Promise<string> { return; }
 
@@ -181,7 +226,7 @@ export class Hotspot {
    *
    * @param {string}        ip  - IP Address that you want the MAC Address of
    *
-   * @return {Promise<string>}  - A Promise for the MAC Address
+   * @returns {Promise<string>}  - A Promise for the MAC Address
    */
   @Cordova()
   static getMacAddressOfHost(ip: string): Promise<string> { return; }
@@ -191,7 +236,7 @@ export class Hotspot {
    *
    * @param {string}        ip  - IP Address you want to test
    *
-   * @return {Promise<boolean>} - A Promise for whether the IP Address is reachable
+   * @returns {Promise<boolean>} - A Promise for whether the IP Address is reachable
    */
   @Cordova()
   static isDnsLive(ip: string): Promise<boolean> { return; }
@@ -201,7 +246,7 @@ export class Hotspot {
    *
    * @param {string}        ip  - IP Address you want to test
    *
-   * @return {Promise<boolean>} - A Promise for whether the IP Address is reachable
+   * @returns {Promise<boolean>} - A Promise for whether the IP Address is reachable
    */
   @Cordova()
   static isPortLive(ip: string): Promise<boolean> { return; }
@@ -209,7 +254,7 @@ export class Hotspot {
   /**
    * Checks if device is rooted
    *
-   * @return {Promise<boolean>} - A Promise for whether the device is rooted
+   * @returns {Promise<boolean>} - A Promise for whether the device is rooted
    */
   @Cordova()
   static isRooted(): Promise<boolean> { return; }