From e59371887f6e93683f509bb6b15f56c84e8a5b68 Mon Sep 17 00:00:00 2001 From: Ibrahim Hadeed Date: Sat, 12 Mar 2016 18:56:01 -0500 Subject: [PATCH] docs(plugins): remove install command --- src/plugins/actionsheet.ts | 4 ---- src/plugins/appavailability.ts | 4 ---- src/plugins/apprate.ts | 4 ---- src/plugins/appversion.ts | 4 ---- src/plugins/badge.ts | 4 ---- src/plugins/barcodescanner.ts | 4 ---- src/plugins/batterystatus.ts | 4 ---- src/plugins/calendar.ts | 7 ++----- src/plugins/camera.ts | 4 ---- src/plugins/clipboard.ts | 4 ---- src/plugins/datepicker.ts | 5 ----- src/plugins/device.ts | 4 ---- src/plugins/devicemotion.ts | 4 ---- src/plugins/deviceorientation.ts | 4 ---- src/plugins/dialogs.ts | 4 ---- src/plugins/flashlight.ts | 4 ---- src/plugins/geolocation.ts | 4 ---- src/plugins/imagepicker.ts | 4 ---- src/plugins/launchnavigator.ts | 4 ---- src/plugins/localnotifications.ts | 4 ---- src/plugins/push.ts | 4 ---- src/plugins/sms.ts | 4 ---- src/plugins/statusbar.ts | 6 +----- src/plugins/toast.ts | 4 ---- 24 files changed, 3 insertions(+), 99 deletions(-) diff --git a/src/plugins/actionsheet.ts b/src/plugins/actionsheet.ts index 205db5830..d72e4e40a 100644 --- a/src/plugins/actionsheet.ts +++ b/src/plugins/actionsheet.ts @@ -7,10 +7,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see the [ActionSheet plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet). * - * ```shell - * cordova plugin add cordova-plugin-actionsheet - * ``` - * * @usage * ```ts * import {ActionSheet} from 'ionic-native'; diff --git a/src/plugins/appavailability.ts b/src/plugins/appavailability.ts index 453f8b8d0..325ead94d 100644 --- a/src/plugins/appavailability.ts +++ b/src/plugins/appavailability.ts @@ -7,10 +7,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). * - * ``` - * cordova plugin add cordova-plugin-appavailability - * ``` - * * @usage * ```js * var app; diff --git a/src/plugins/apprate.ts b/src/plugins/apprate.ts index 5b56fac79..e558061f0 100644 --- a/src/plugins/apprate.ts +++ b/src/plugins/apprate.ts @@ -9,10 +9,6 @@ declare var window; * * Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate). * - * ```shell - * cordova plugin add cordova-plugin-apprate - * ```` - * * @usage * ```js * AppRate.preferences.storeAppURL.ios = ''; diff --git a/src/plugins/appversion.ts b/src/plugins/appversion.ts index d7c09be69..71342255d 100644 --- a/src/plugins/appversion.ts +++ b/src/plugins/appversion.ts @@ -7,10 +7,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](https://github.com/whiteoctober/cordova-plugin-app-version). * - * ```shell - * cordova plugin add cordova-plugin-app-version - * ```` - * * @usage * ```js * AppVersion.getAppName(); diff --git a/src/plugins/badge.ts b/src/plugins/badge.ts index 010df3d26..f90b576d0 100644 --- a/src/plugins/badge.ts +++ b/src/plugins/badge.ts @@ -7,10 +7,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge). * - * ```shell - * cordova plugin add cordova-plugin-badge - * ``` - * * @usage * ```js * Badge.set(10); diff --git a/src/plugins/barcodescanner.ts b/src/plugins/barcodescanner.ts index e0585df4b..635373003 100644 --- a/src/plugins/barcodescanner.ts +++ b/src/plugins/barcodescanner.ts @@ -7,10 +7,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner). * - * ```shell - * cordova plugin add phonegap-plugin-barcodescanner - * ``` - * * @usage * ```js * BarcodeScanner.scan().then((barcodeData) => { diff --git a/src/plugins/batterystatus.ts b/src/plugins/batterystatus.ts index 278ccf0f8..5e940464c 100644 --- a/src/plugins/batterystatus.ts +++ b/src/plugins/batterystatus.ts @@ -6,10 +6,6 @@ import {Observable} from "rxjs/Observable"; * @description * Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status). * - * ```shell - * cordova plugin add cordova-plugin-batterystatus - * ``` - * * @usage * ```js * // watch change in battery status diff --git a/src/plugins/calendar.ts b/src/plugins/calendar.ts index e0a906694..93574fd68 100644 --- a/src/plugins/calendar.ts +++ b/src/plugins/calendar.ts @@ -23,11 +23,8 @@ export interface Calendar { * * Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see the [Calendar plugin docs](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin). * - * ```shell - * cordova plugin add cordova-plugin-calendar - * ``` - * - * + * @usage + * */ @Plugin({ plugin: 'cordova-plugin-calendar', diff --git a/src/plugins/camera.ts b/src/plugins/camera.ts index a6812c15c..29dc1059b 100644 --- a/src/plugins/camera.ts +++ b/src/plugins/camera.ts @@ -91,10 +91,6 @@ export interface CameraPopoverOptions { * * Requires Cordova plugin: `cordova-plugin-camera`. For more info, please see the [Cordova Camera Plugin Docs](https://github.com/apache/cordova-plugin-camera). * - * ```shell - * cordova plugin add cordova-plugin-camera - * ``` - * * @usage * ```js * Camera.getPicture(options).then((imageData) => { diff --git a/src/plugins/clipboard.ts b/src/plugins/clipboard.ts index d52c59990..99f80b1cf 100644 --- a/src/plugins/clipboard.ts +++ b/src/plugins/clipboard.ts @@ -8,10 +8,6 @@ import {Plugin, Cordova} from './plugin'; * Requires Cordova plugin: https://github.com/VersoSolutions/CordovaClipboard * For more info, please see the [Clipboard plugin docs](https://github.com/VersoSolutions/CordovaClipboard.git). * - * ```shell - * cordova plugin add https://github.com/VersoSolutions/CordovaClipboard.git - * ``` - * * @usage * ```js * Clipboard.copy("Hello world"); diff --git a/src/plugins/datepicker.ts b/src/plugins/datepicker.ts index 51b883a91..60b1134ef 100644 --- a/src/plugins/datepicker.ts +++ b/src/plugins/datepicker.ts @@ -72,11 +72,6 @@ export interface datePickerOptions { * * Requires Cordova plugin: `cordova-plugin-datepicker`. For more info, please see the [DatePicker plugin docs](https://github.com/VitaliiBlagodir/cordova-plugin-datepicker). * - * Install the plugin by running the following command: - * ```shell - * cordova plugin add cordova-plugin-datepicker - * ``` - * * @usage * ```js * DatePicker.show({ diff --git a/src/plugins/device.ts b/src/plugins/device.ts index f83a48f12..c1b9f7a6c 100644 --- a/src/plugins/device.ts +++ b/src/plugins/device.ts @@ -31,10 +31,6 @@ export interface Device { * @description * Access information about the underlying device and platform. * - * ```shell - * cordova plugin add cordova-plugin-device - * ``` - * * @usage * ```js * let info = Device.getDevice(); diff --git a/src/plugins/devicemotion.ts b/src/plugins/devicemotion.ts index ac117e76b..a6669015a 100644 --- a/src/plugins/devicemotion.ts +++ b/src/plugins/devicemotion.ts @@ -39,10 +39,6 @@ export interface accelerometerOptions { * @description * Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion docs](https://github.com/apache/cordova-plugin-device-motion). * - * ```shell - * cordova plugin add cordova-plugin-device-motion - * ```` - * * @usage * ```ts * diff --git a/src/plugins/deviceorientation.ts b/src/plugins/deviceorientation.ts index 07226cb23..c4fe6c428 100644 --- a/src/plugins/deviceorientation.ts +++ b/src/plugins/deviceorientation.ts @@ -44,10 +44,6 @@ export interface CompassOptions { * @description * Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device Orientation docs](https://github.com/apache/cordova-plugin-device-orientation). * - * ```shell - * cordova plugin add cordova-plugin-device-orientation - * ```` - * * @usage * ```ts * // Get the device current compass heading diff --git a/src/plugins/dialogs.ts b/src/plugins/dialogs.ts index b3674fa32..406b0c705 100644 --- a/src/plugins/dialogs.ts +++ b/src/plugins/dialogs.ts @@ -22,10 +22,6 @@ export interface promptCallback { * * Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the [Dialogs plugin docs](https://github.com/apache/cordova-plugin-dialogs). * - * ```shell - * cordova plugin add cordova-plugin-dialogs - * ``` - * * @usage * ```js * ``` diff --git a/src/plugins/flashlight.ts b/src/plugins/flashlight.ts index c2f925ac0..f94ef72a6 100644 --- a/src/plugins/flashlight.ts +++ b/src/plugins/flashlight.ts @@ -6,10 +6,6 @@ import {Plugin, Cordova} from './plugin'; * * Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see the [Flashlight plugin docs](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin). * - * ```shell - * cordova plugin add cordova-plugin-flashlight - * ``` - * * @usage * ```js * ``` diff --git a/src/plugins/geolocation.ts b/src/plugins/geolocation.ts index 1251a0504..1c8d02d96 100644 --- a/src/plugins/geolocation.ts +++ b/src/plugins/geolocation.ts @@ -99,10 +99,6 @@ export interface GeolocationOptions { * * This API is based on the W3C Geolocation API Specification, and only executes on devices that don't already provide an implementation. * - * ```shell - * cordova plugin add cordova-plugin-geolocation - * ``` - * * @usage * * ```ts diff --git a/src/plugins/imagepicker.ts b/src/plugins/imagepicker.ts index 3fd2f3526..c7c108149 100644 --- a/src/plugins/imagepicker.ts +++ b/src/plugins/imagepicker.ts @@ -25,10 +25,6 @@ export interface ImagePickerOptions { * Requires Cordova plugin: `cordova-plugin-image-picker`. * For more info, please see the https://github.com/wymsee/cordova-imagePicker * - * ```shell - * cordova plugin add cordova-plugin-image-picker - * ``` - * * @usage * ```js * ImagePicker.getPictures(options).then((results) => { diff --git a/src/plugins/launchnavigator.ts b/src/plugins/launchnavigator.ts index 0d2af1a39..d6688b416 100644 --- a/src/plugins/launchnavigator.ts +++ b/src/plugins/launchnavigator.ts @@ -51,10 +51,6 @@ export interface launchNavigatorOptions { * @description * Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the [LaunchNavigator plugin docs](https://github.com/dpa99c/phonegap-launch-navigator). * - * ```shell - * cordova plugin add uk.co.workingedge.phonegap.plugin.launchnavigator - * ``` - * * @usage * ```js * LaunchNavigator.navigate("Toronto, ON", "London, ON") diff --git a/src/plugins/localnotifications.ts b/src/plugins/localnotifications.ts index 8b012d137..6847ff51c 100644 --- a/src/plugins/localnotifications.ts +++ b/src/plugins/localnotifications.ts @@ -4,10 +4,6 @@ import {Plugin, Cordova} from './plugin'; * @description * This plugin allows you to display local notifications on the device * - * ```shell - * cordova plugin add cordova-plugin-local-notifications - * ``` - * * @usage * ```ts * // Schedule a single notification diff --git a/src/plugins/push.ts b/src/plugins/push.ts index 29222a42d..52392bda4 100644 --- a/src/plugins/push.ts +++ b/src/plugins/push.ts @@ -252,10 +252,6 @@ 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). * - * ```shell - * cordova plugin add 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). */ @Plugin({ diff --git a/src/plugins/sms.ts b/src/plugins/sms.ts index 9bc34bc6d..a389c0dde 100644 --- a/src/plugins/sms.ts +++ b/src/plugins/sms.ts @@ -26,10 +26,6 @@ export interface smsOptionsAndroid { * * Requires Cordova plugin: cordova-plugin-sms. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin). * - * ```shell - * cordova plugin add cordova-sms-plugin - * ``` - * * @usage * ```ts * diff --git a/src/plugins/statusbar.ts b/src/plugins/statusbar.ts index 2dace01f2..63370e113 100644 --- a/src/plugins/statusbar.ts +++ b/src/plugins/statusbar.ts @@ -9,15 +9,11 @@ declare var window; * * Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar). * - * ```shell - * cordova plugin add cordova-plugin-statusbar - * ``` - * * @usage * ```ts * StatuBar.overlaysWebView(true); * - * StatusBar.styleDefault(); + * StatusBar. * ``` * */ diff --git a/src/plugins/toast.ts b/src/plugins/toast.ts index 494e264d6..263ee7a84 100644 --- a/src/plugins/toast.ts +++ b/src/plugins/toast.ts @@ -14,10 +14,6 @@ export interface ToastOptions { * * Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin). * - * ```shell - * cordova plugin add cordova-plugin-x-toast - * ``` - * * @usage * ```ts * Toast.show("I'm a toast", 5000, "center").subscribe(