From 3b7573be7f193dd87f272ceea79b9616534280b8 Mon Sep 17 00:00:00 2001
From: Ibrahim Hadeed <ibby93@gmail.com>
Date: Thu, 24 Mar 2016 13:00:18 -0400
Subject: [PATCH] docs(plugins): add import statements for usage clarity
---
src/plugins/appavailability.ts | 3 +++
src/plugins/apprate.ts | 3 +++
src/plugins/appversion.ts | 3 +++
src/plugins/badge.ts | 3 +++
src/plugins/barcodescanner.ts | 3 +++
src/plugins/base64togallery.ts | 3 +++
src/plugins/batterystatus.ts | 4 ++++
src/plugins/calendar.ts | 4 ++++
src/plugins/clipboard.ts | 4 ++++
src/plugins/contacts.ts | 4 ++++
src/plugins/datepicker.ts | 4 ++++
src/plugins/dbmeter.ts | 4 ++++
src/plugins/device.ts | 4 ++++
src/plugins/devicemotion.ts | 3 +++
src/plugins/deviceorientation.ts | 4 ++++
src/plugins/dialogs.ts | 5 +++++
src/plugins/facebook.ts | 8 ++++++++
src/plugins/flashlight.ts | 4 ++++
src/plugins/geolocation.ts | 4 ++++
src/plugins/globalization.ts | 6 ++++++
src/plugins/hotspot.ts | 6 ++++++
src/plugins/imagepicker.ts | 4 ++++
src/plugins/keyboard.ts | 11 +++++++++++
src/plugins/launchnavigator.ts | 4 ++++
src/plugins/localnotifications.ts | 4 ++++
src/plugins/push.ts | 8 ++++++++
src/plugins/sms.ts | 3 +++
src/plugins/splashscreen.ts | 4 ++++
src/plugins/statusbar.ts | 6 +++++-
src/plugins/toast.ts | 4 +++-
src/plugins/touchid.ts | 6 ++++++
src/plugins/vibration.ts | 4 ++++
32 files changed, 142 insertions(+), 2 deletions(-)
diff --git a/src/plugins/appavailability.ts b/src/plugins/appavailability.ts
index 0794aace..8d83239d 100644
--- a/src/plugins/appavailability.ts
+++ b/src/plugins/appavailability.ts
@@ -9,6 +9,9 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {AppAvailability} from 'ionic-native';
+ *
+ *
* var app;
*
* if(device.platform === 'iOS') {
diff --git a/src/plugins/apprate.ts b/src/plugins/apprate.ts
index 61f98c4c..915d9d5f 100644
--- a/src/plugins/apprate.ts
+++ b/src/plugins/apprate.ts
@@ -11,6 +11,9 @@ declare var window;
*
* @usage
* ```js
+ * import {AppRate} from 'ionic-native';
+ *
+ *
* AppRate.preferences.storeAppURL.ios = '<my_app_id>';
* AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
* AppRate.preferences.storeAppURL.blackberry = 'appworld://content/[App Id]/';
diff --git a/src/plugins/appversion.ts b/src/plugins/appversion.ts
index 0d3f80a3..393cc4d7 100644
--- a/src/plugins/appversion.ts
+++ b/src/plugins/appversion.ts
@@ -9,6 +9,9 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {AppVersion} from 'ionic-native';
+ *
+ *
* AppVersion.getAppName();
* AppVersion.getPackageName();
* AppVersion.getVersionCode();
diff --git a/src/plugins/badge.ts b/src/plugins/badge.ts
index 0e1b2484..80adb115 100644
--- a/src/plugins/badge.ts
+++ b/src/plugins/badge.ts
@@ -9,6 +9,9 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {Badge} from 'ionic-native';
+ *
+ *
* Badge.set(10);
* Badge.increase();
* Badge.clear();
diff --git a/src/plugins/barcodescanner.ts b/src/plugins/barcodescanner.ts
index 18965d04..cc76e191 100644
--- a/src/plugins/barcodescanner.ts
+++ b/src/plugins/barcodescanner.ts
@@ -9,6 +9,9 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {BarcodeScanner} from 'ionic-native';
+ *
+ *
* BarcodeScanner.scan().then((barcodeData) => {
* // Success! Barcode data is here
* }, (err) => {
diff --git a/src/plugins/base64togallery.ts b/src/plugins/base64togallery.ts
index 5f996e0d..2e5e9a23 100644
--- a/src/plugins/base64togallery.ts
+++ b/src/plugins/base64togallery.ts
@@ -5,6 +5,9 @@ import {Plugin, Cordova} from './plugin'
* @platforms Android, iOS, Windows Phone
* @usage
* ```ts
+ * import {Base64ToGallery} from 'ionic-native';
+ *
+ *
* Base64ToGallery.base64ToGallery(base64Data, 'img_').then(
* res => console.log("Saved image to gallery ", res),
* err => console.log("Error saving image to gallery ", err)
diff --git a/src/plugins/batterystatus.ts b/src/plugins/batterystatus.ts
index fcbab0fa..4dccaee5 100644
--- a/src/plugins/batterystatus.ts
+++ b/src/plugins/batterystatus.ts
@@ -8,6 +8,10 @@ import {Observable} from "rxjs/Observable";
*
* @usage
* ```js
+ * import {BatteryStatus} from 'ionic-native';
+ *
+ *
+ *
* // watch change in battery status
* let subscription = BatteryStatus.onChange().subscribe(
* status => {
diff --git a/src/plugins/calendar.ts b/src/plugins/calendar.ts
index e92d65c4..7b4a062f 100644
--- a/src/plugins/calendar.ts
+++ b/src/plugins/calendar.ts
@@ -38,6 +38,10 @@ export class Calendar {
*
* @usage
* ```
+ * import {Calendar} from 'ionic-native';
+ *
+ *
+ *
* Calendar.createCalendar('MyCalendar').then(
* (msg) => { console.log(msg); },
* (err) => { console.log(err); }
diff --git a/src/plugins/clipboard.ts b/src/plugins/clipboard.ts
index 07559137..ad39b931 100644
--- a/src/plugins/clipboard.ts
+++ b/src/plugins/clipboard.ts
@@ -10,6 +10,10 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {Clipboard} from 'ionic-native';
+ *
+ *
+ *
* Clipboard.copy("Hello world");
*
* Clipboard.paste().then(
diff --git a/src/plugins/contacts.ts b/src/plugins/contacts.ts
index ea6955be..ea0d281d 100644
--- a/src/plugins/contacts.ts
+++ b/src/plugins/contacts.ts
@@ -198,6 +198,10 @@ declare var Contact: {
* @usage
*
* ```js
+ * import {Contacts} from 'ionic-native';
+ *
+ *
+ *
* Contacts.save({
* displayName: "Mr. Ionitron"
* }).then((contact) => {}, (err) => {})
diff --git a/src/plugins/datepicker.ts b/src/plugins/datepicker.ts
index 47b89dda..d9994eb3 100644
--- a/src/plugins/datepicker.ts
+++ b/src/plugins/datepicker.ts
@@ -74,6 +74,10 @@ export interface datePickerOptions {
*
* @usage
* ```js
+ * import {DatePicker} from 'ionic-native';
+ *
+ *
+ *
* DatePicker.show({
* date: new Date(),
* mode: 'date'
diff --git a/src/plugins/dbmeter.ts b/src/plugins/dbmeter.ts
index 00fd2afd..34a32c74 100644
--- a/src/plugins/dbmeter.ts
+++ b/src/plugins/dbmeter.ts
@@ -6,6 +6,10 @@ import {Observable} from "rxjs/Observable";
* @platforms Android, iOS
* @usage
* ```ts
+ * import {DBMeter} from 'ionic-native';
+ *
+ *
+ *
* // Start listening
* let subscription = DBMeter.start().subscribe(
* data => console.log(data)
diff --git a/src/plugins/device.ts b/src/plugins/device.ts
index 251c1c71..78f8cb44 100644
--- a/src/plugins/device.ts
+++ b/src/plugins/device.ts
@@ -33,6 +33,10 @@ export interface Device {
*
* @usage
* ```js
+ * import {Device} from 'ionic-native';
+ *
+ *
+ *
* console.log('Device UUID is: ' + Device.device.uuid);
* ```
*/
diff --git a/src/plugins/devicemotion.ts b/src/plugins/devicemotion.ts
index a4d0cf01..0dc6676e 100644
--- a/src/plugins/devicemotion.ts
+++ b/src/plugins/devicemotion.ts
@@ -41,6 +41,9 @@ export interface accelerometerOptions {
*
* @usage
* ```ts
+ * import {DeviceMotion} from 'ionic-native';
+ *
+ *
*
* // Get the device current acceleration
* DeviceMotion.getCurrentAcceleration().then(
diff --git a/src/plugins/deviceorientation.ts b/src/plugins/deviceorientation.ts
index 31a87dc7..a51824eb 100644
--- a/src/plugins/deviceorientation.ts
+++ b/src/plugins/deviceorientation.ts
@@ -46,6 +46,10 @@ export interface CompassOptions {
*
* @usage
* ```ts
+ * import {DeviceOrientation} from 'ionic-native';
+ *
+ *
+ *
* // Get the device current compass heading
* DeviceOrientation.getCurrentHeading().then(
* data => console.log(data),
diff --git a/src/plugins/dialogs.ts b/src/plugins/dialogs.ts
index 406b0c70..f7037318 100644
--- a/src/plugins/dialogs.ts
+++ b/src/plugins/dialogs.ts
@@ -24,6 +24,11 @@ export interface promptCallback {
*
* @usage
* ```js
+ * import {Dialogs} from 'ionic-native';
+ *
+ *
+ *
+ *
* ```
*/
@Plugin({
diff --git a/src/plugins/facebook.ts b/src/plugins/facebook.ts
index fce34683..e3a86a5b 100644
--- a/src/plugins/facebook.ts
+++ b/src/plugins/facebook.ts
@@ -68,6 +68,14 @@ import {Plugin, Cordova} from './plugin';
*
* For tracking events, see `logEvent` and `logPurchase`.
*
+ * @usage
+ * ```js
+ * import {Facebook} from 'ionic-native';
+ *
+ *
+ *
+ * ```
+ *
*/
@Plugin({
plugin: 'cordova-plugin-facebook4',
diff --git a/src/plugins/flashlight.ts b/src/plugins/flashlight.ts
index f94ef72a..e5bd4477 100644
--- a/src/plugins/flashlight.ts
+++ b/src/plugins/flashlight.ts
@@ -8,6 +8,10 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```js
+ * import {Flashlight} from 'ionic-native';
+ *
+ *
+ *
* ```
*/
@Plugin({
diff --git a/src/plugins/geolocation.ts b/src/plugins/geolocation.ts
index 70214edd..4064b694 100644
--- a/src/plugins/geolocation.ts
+++ b/src/plugins/geolocation.ts
@@ -102,6 +102,10 @@ export interface GeolocationOptions {
* @usage
*
* ```ts
+ * import {Geolocation} from 'ionic-native';
+ *
+ *
+ *
* Geolocation.getCurrentPosition().then((resp) => {
* //resp.coords.latitude
* //resp.coords.longitude
diff --git a/src/plugins/globalization.ts b/src/plugins/globalization.ts
index ea250b01..0b766c6c 100644
--- a/src/plugins/globalization.ts
+++ b/src/plugins/globalization.ts
@@ -4,6 +4,12 @@ import {Plugin, Cordova} from './plugin';
* @name Globalization
* @description
* @usage
+ * ```js
+ * import {Globalization} from 'ionic-native';
+ *
+ *
+ *
+ * ```
*/
@Plugin({
plugin: 'cordova-plugin-globalization',
diff --git a/src/plugins/hotspot.ts b/src/plugins/hotspot.ts
index d876d4fb..96398660 100644
--- a/src/plugins/hotspot.ts
+++ b/src/plugins/hotspot.ts
@@ -5,6 +5,12 @@ import {Plugin, Cordova} from './plugin'
* @description
* @platforms Android
* @usage
+ * ```js
+ * import {Hotspot} from 'ionic-native';
+ *
+ *
+ *
+ * ```
*/
@Plugin({
plugin: 'cordova-plugin-hotspot',
diff --git a/src/plugins/imagepicker.ts b/src/plugins/imagepicker.ts
index 9da561eb..8f80186a 100644
--- a/src/plugins/imagepicker.ts
+++ b/src/plugins/imagepicker.ts
@@ -27,6 +27,10 @@ export interface ImagePickerOptions {
*
* @usage
* ```js
+ * import {ImagePicker} from 'ionic-native';
+ *
+ *
+ *
* ImagePicker.getPictures(options).then((results) => {
* for (var i = 0; i < results.length; i++) {
* console.log('Image URI: ' + results[i]);
diff --git a/src/plugins/keyboard.ts b/src/plugins/keyboard.ts
index 5f196745..e4550a8d 100644
--- a/src/plugins/keyboard.ts
+++ b/src/plugins/keyboard.ts
@@ -1,6 +1,17 @@
import {Cordova, Plugin} from './plugin'
import {Observable} from "rxjs/Observable";
+/**
+ * @name Keyboard
+ * @description
+ * @usage
+ * ```js
+ * import {Keyboard} from 'ionic-native';
+ *
+ *
+ *
+ * ```
+ */
@Plugin({
plugin: 'ionic-plugin-keyboard',
pluginRef: 'cordova.plugins.Keyboard',
diff --git a/src/plugins/launchnavigator.ts b/src/plugins/launchnavigator.ts
index 359c6ef6..376923dc 100644
--- a/src/plugins/launchnavigator.ts
+++ b/src/plugins/launchnavigator.ts
@@ -53,6 +53,10 @@ export interface launchNavigatorOptions {
*
* @usage
* ```js
+ * import {LaunchNavigator} from 'ionic-native';
+ *
+ *
+ *
* LaunchNavigator.navigate("Toronto, ON", "London, ON")
* .then(
* success => console.log("Launched navigator"),
diff --git a/src/plugins/localnotifications.ts b/src/plugins/localnotifications.ts
index 2b0d086f..a54ba2c5 100644
--- a/src/plugins/localnotifications.ts
+++ b/src/plugins/localnotifications.ts
@@ -6,6 +6,10 @@ import {Plugin, Cordova} from './plugin';
*
* @usage
* ```ts
+ * import {LocalNotifications} from 'ionic-native';
+ *
+ *
+ *
* // Schedule a single notification
* LocalNotifications.schedule({
* id: 1,
diff --git a/src/plugins/push.ts b/src/plugins/push.ts
index deb3e67a..cbae429a 100644
--- a/src/plugins/push.ts
+++ b/src/plugins/push.ts
@@ -253,6 +253,14 @@ declare var PushNotification: {
* Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the [Push plugin docs](https://github.com/phonegap/phonegap-plugin-push).
*
* For TypeScript users, see the [Push plugin docs about using TypeScript for custom notifications](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/TYPESCRIPT.md).
+ *
+ * @usage
+ * ```js
+ * import {Push} from 'ionic-native';
+ *
+ *
+ *
+ * ```
*/
@Plugin({
plugin: 'phonegap-plugin-push',
diff --git a/src/plugins/sms.ts b/src/plugins/sms.ts
index a6bca8a0..ffd1987b 100644
--- a/src/plugins/sms.ts
+++ b/src/plugins/sms.ts
@@ -31,6 +31,9 @@ export interface smsOptionsAndroid {
*
* @usage
* ```ts
+ * import {SMS} from 'ionic-native';
+ *
+ *
*
* // Send a text message using default options
* SMS.send('416123456','Hello world!');
diff --git a/src/plugins/splashscreen.ts b/src/plugins/splashscreen.ts
index 0069d163..f376576b 100644
--- a/src/plugins/splashscreen.ts
+++ b/src/plugins/splashscreen.ts
@@ -5,6 +5,10 @@ import {Plugin, Cordova} from './plugin'
* @description This plugin displays and hides a splash screen during application launch. The methods below allows showing and hiding the splashscreen after the app has loaded.
* @usage
* ```ts
+ * import {Splashscreen} from 'ionic-native';
+ *
+ *
+ *
* Splashscreen.show();
*
* Splashscreen.hide();
diff --git a/src/plugins/statusbar.ts b/src/plugins/statusbar.ts
index 63370e11..cc04e569 100644
--- a/src/plugins/statusbar.ts
+++ b/src/plugins/statusbar.ts
@@ -3,7 +3,7 @@ import {Plugin, Cordova, CordovaProperty} from './plugin';
declare var window;
/**
- * @name StatusBar
+ * @name Status Bar
* @description
* Manage the appearance of the native status bar.
*
@@ -11,6 +11,10 @@ declare var window;
*
* @usage
* ```ts
+ * import {StatusBar} from 'ionic-native';
+ *
+ *
+ *
* StatuBar.overlaysWebView(true);
*
* StatusBar.
diff --git a/src/plugins/toast.ts b/src/plugins/toast.ts
index 0e0a1e2c..7d300a18 100644
--- a/src/plugins/toast.ts
+++ b/src/plugins/toast.ts
@@ -17,7 +17,9 @@ export interface ToastOptions {
* @usage
* ```ts
* import {Toast} from 'ionic-native';
- *
+ *
+ *
+ *
* Toast.show("I'm a toast", 5000, "center").subscribe(
* toast => {
* console.log(toast);
diff --git a/src/plugins/touchid.ts b/src/plugins/touchid.ts
index fc7a20de..76c0b316 100644
--- a/src/plugins/touchid.ts
+++ b/src/plugins/touchid.ts
@@ -19,7 +19,13 @@ import {Plugin, Cordova} from './plugin';
* - `-4` - The scan was cancelled by the system (Home button for example)
* - `-6` - TouchID is not Available
* - `-8` - TouchID is locked out from too many tries
+ * @usage
+ * ```js
+ * import {TouchID} from 'ionic-native';
*
+ *
+ *
+ * ```
*/
@Plugin({
plugin: 'cordova-plugin-touch-id',
diff --git a/src/plugins/vibration.ts b/src/plugins/vibration.ts
index cac11e08..77185154 100644
--- a/src/plugins/vibration.ts
+++ b/src/plugins/vibration.ts
@@ -4,6 +4,10 @@ import {Plugin, Cordova} from './plugin'
* @description Vibrates the device
* @usage
* ```ts
+ * import {Vibration} from 'ionic-native';
+ *
+ *
+ *
* // Vibrate the device for a second
* Vibration.vibrate(1000);
*