Adding some JSDoc definitions

This commit is contained in:
Louis Orleans 2016-05-05 18:06:33 -07:00
parent b4b131c82a
commit 9682ac8f11
5 changed files with 20 additions and 2 deletions

View File

@ -1,3 +1,6 @@
/**
* @name ConnectionInfo
*/
export class ConnectionInfo { export class ConnectionInfo {
/** /**
* @property {string} SSID * @property {string} SSID

View File

@ -1,3 +1,6 @@
/**
* @name HotspotDevice
*/
export class HotspotDevice { export class HotspotDevice {
/** /**
* @property {string} ip * @property {string} ip

View File

@ -10,9 +10,13 @@ import {HotspotDevice} from './hotspot-device.model';
* @description * @description
* @usage * @usage
* ```js * ```js
* import {Hotspot} from 'ionic-native'; * import {Hotspot, Network} from 'ionic-native';
*
* *
* ...
* Hotspot.scanWifi().then((networks: Array<Network>) => {
* console.log(networks);
* });
* ...
* *
* ``` * ```
*/ */

View File

@ -1,3 +1,6 @@
/**
* @name ConnectionInfo
*/
export class NetworkConfig { export class NetworkConfig {
/** /**
* @property {string} deviceIPAddress - Device IP Address * @property {string} deviceIPAddress - Device IP Address

View File

@ -1,3 +1,8 @@
/**
* @name Network
* @description
* Based on [ScanResult](http://developer.android.com/reference/android/net/wifi/ScanResult.html)
*/
export class Network { export class Network {
/** /**
* @property {string} SSID * @property {string} SSID