From 9682ac8f1136baa8abb8ac849daed117177a1510 Mon Sep 17 00:00:00 2001 From: Louis Orleans Date: Thu, 5 May 2016 18:06:33 -0700 Subject: [PATCH] Adding some JSDoc definitions --- src/plugins/connection-info.model.ts | 3 +++ src/plugins/hotspot-device.model.ts | 3 +++ src/plugins/hotspot.ts | 8 ++++++-- src/plugins/network-config.model.ts | 3 +++ src/plugins/network.model.ts | 5 +++++ 5 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/plugins/connection-info.model.ts b/src/plugins/connection-info.model.ts index 572b7a99f..21c785da9 100644 --- a/src/plugins/connection-info.model.ts +++ b/src/plugins/connection-info.model.ts @@ -1,3 +1,6 @@ +/** + * @name ConnectionInfo + */ export class ConnectionInfo { /** * @property {string} SSID diff --git a/src/plugins/hotspot-device.model.ts b/src/plugins/hotspot-device.model.ts index ffb727eb8..fd9a7f736 100644 --- a/src/plugins/hotspot-device.model.ts +++ b/src/plugins/hotspot-device.model.ts @@ -1,3 +1,6 @@ +/** + * @name HotspotDevice + */ export class HotspotDevice { /** * @property {string} ip diff --git a/src/plugins/hotspot.ts b/src/plugins/hotspot.ts index d294e208e..dfdefe312 100644 --- a/src/plugins/hotspot.ts +++ b/src/plugins/hotspot.ts @@ -10,9 +10,13 @@ import {HotspotDevice} from './hotspot-device.model'; * @description * @usage * ```js - * import {Hotspot} from 'ionic-native'; - * + * import {Hotspot, Network} from 'ionic-native'; * + * ... + * Hotspot.scanWifi().then((networks: Array) => { + * console.log(networks); + * }); + * ... * * ``` */ diff --git a/src/plugins/network-config.model.ts b/src/plugins/network-config.model.ts index c2fafa934..32164cddc 100644 --- a/src/plugins/network-config.model.ts +++ b/src/plugins/network-config.model.ts @@ -1,3 +1,6 @@ +/** + * @name ConnectionInfo + */ export class NetworkConfig { /** * @property {string} deviceIPAddress - Device IP Address diff --git a/src/plugins/network.model.ts b/src/plugins/network.model.ts index 8260791d8..45f930953 100644 --- a/src/plugins/network.model.ts +++ b/src/plugins/network.model.ts @@ -1,3 +1,8 @@ +/** + * @name Network + * @description + * Based on [ScanResult](http://developer.android.com/reference/android/net/wifi/ScanResult.html) + */ export class Network { /** * @property {string} SSID