From df1cee1fc68ef2a9ce784d233a9bf8c6dcf094bb Mon Sep 17 00:00:00 2001 From: perry Date: Tue, 10 May 2016 17:49:21 -0500 Subject: [PATCH] copy edits from @kgindervogel --- src/plugins/apprate.ts | 28 +++++++++++++++------------- src/plugins/diagnostic.ts | 5 +++-- src/plugins/file.ts | 6 +++--- src/plugins/flashlight.ts | 10 +++++----- src/plugins/keyboard.ts | 4 ++-- 5 files changed, 28 insertions(+), 25 deletions(-) diff --git a/src/plugins/apprate.ts b/src/plugins/apprate.ts index b1e36c154..96bc4add4 100644 --- a/src/plugins/apprate.ts +++ b/src/plugins/apprate.ts @@ -32,19 +32,21 @@ export class AppRate { /** * Rating dialog preferences * - * useLanguage {String} null - custom BCP 47 language tag - * displayAppName {String} '' - custom application title - * promptAgainForEachNewVersion {Boolean} true - show dialog again when application version will be updated - * usesUntilPrompt {Integer} 3 - count of runs of application before dialog will be displayed - * openStoreInApp {Boolean} false - leave app or no when application page opened in app store (now supported only for iOS) - * useCustomRateDialog {Boolean} false - use custom view for rate dialog - * callbacks.onButtonClicked {Function} null - call back function. called when user clicked on rate-dialog buttons - * callbacks.onRateDialogShow {Function} null - call back function. called when rate-dialog showing - * storeAppURL.ios {String} null - application id in AppStore - * storeAppURL.android {String} null - application URL in GooglePlay - * storeAppURL.blackberry {String} null - application URL in AppWorld - * storeAppURL.windows8 {String} null - application URL in WindowsStore - * customLocale {Object} null - custom locale object + * | Option | Type | Default | Description | + * |------------------------------|------------|---------|----------------------------------------------------------------------------------------| + * | useLanguage | `String` | null | custom BCP 47 language tag | + * | displayAppName | `String` | '' | custom application title | + * | promptAgainForEachNewVersion | `Boolean` | true | show dialog again when application version will be updated | + * | usesUntilPrompt | `Integer` | 3 | count of runs of application before dialog will be displayed | + * | openStoreInApp | `Boolean` | false | leave app or no when application page opened in app store (now supported only for iOS) | + * | useCustomRateDialog | `Boolean` | false | use custom view for rate dialog | + * | callbacks.onButtonClicked | `Function` | null | call back function. called when user clicked on rate-dialog buttons | + * | callbacks.onRateDialogShow | `Function` | null | call back function. called when rate-dialog showing | + * | storeAppURL.ios | `String` | null | application id in AppStore | + * | storeAppURL.android | `String` | null | application URL in GooglePlay | + * | storeAppURL.blackberry | `String` | null | application URL in AppWorld | + * | storeAppURL.windows8 | `String` | null | application URL in WindowsStore | + * | customLocale | `Object` | null | custom locale object | * @type {{}} */ @CordovaProperty diff --git a/src/plugins/diagnostic.ts b/src/plugins/diagnostic.ts index 6db5489f2..01b0be072 100644 --- a/src/plugins/diagnostic.ts +++ b/src/plugins/diagnostic.ts @@ -3,6 +3,7 @@ import {Plugin, Cordova} from './plugin'; @Plugin({ plugin: 'cordova.plugins.diagnostic', pluginRef: 'cordova.plugins.diagnostic' + repo: 'https://github.com/floatinghotpot/cordova-plugin-admob' }) export class Diagnostic { /** @@ -20,7 +21,7 @@ export class Diagnostic { /** * Checks if Wifi is connected/enabled. On iOS this returns true if the device is connected to a network by WiFi. On Android and Windows 10 Mobile this returns true if the WiFi setting is set to enabled. - * On Android this requires permission + * On Android this requires permission. `` */ @Cordova() static isWifiEnabled() { @@ -185,4 +186,4 @@ export class Diagnostic { -} \ No newline at end of file +} diff --git a/src/plugins/file.ts b/src/plugins/file.ts index d59426de8..35ff868fe 100644 --- a/src/plugins/file.ts +++ b/src/plugins/file.ts @@ -118,7 +118,7 @@ export class File { } /** - * Remove a directory at a given path + * Remove a directory at a given path. * * @param {string} path The path to the directory * @param {string} dirName The directory name @@ -158,7 +158,7 @@ export class File { } /** - * Move a directory to a given path + * Move a directory to a given path. * * @param {string} path The source path to the directory * @param {string} dirName The source directory name @@ -252,7 +252,7 @@ export class File { } /** - * List files and directory from a given path + * List files and directory from a given path. * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} dirName Name of directory diff --git a/src/plugins/flashlight.ts b/src/plugins/flashlight.ts index 1447b0e3b..80aa7ee30 100644 --- a/src/plugins/flashlight.ts +++ b/src/plugins/flashlight.ts @@ -23,8 +23,8 @@ export class Flashlight { /** - * Checks if the flash light is available - * @returns {Promise} Returns a promise that resolves with a boolean stating if the flash light is available. + * Checks if the flashlight is available + * @returns {Promise} Returns a promise that resolves with a boolean stating if the flashlight is available. */ @Cordova() static available(): Promise { return; } @@ -37,7 +37,7 @@ export class Flashlight { static switchOn(): Promise { return; } /** - * Switches the flash light off + * Switches the flashlight off * @returns {Promise} */ @Cordova() @@ -52,7 +52,7 @@ export class Flashlight { /** - * Checks if the flash light is turned on. + * Checks if the flashlight is turned on. * Returns a boolean */ @Cordova({ @@ -60,4 +60,4 @@ export class Flashlight { }) static isSwitchedOn(): boolean { return; } -} \ No newline at end of file +} diff --git a/src/plugins/keyboard.ts b/src/plugins/keyboard.ts index e3bf63165..7c01269cc 100644 --- a/src/plugins/keyboard.ts +++ b/src/plugins/keyboard.ts @@ -37,7 +37,7 @@ export class Keyboard { static show(): void {} /** - * Close the keyboard if open + * Close the keyboard if open. */ @Cordova({ sync: true, @@ -75,4 +75,4 @@ export class Keyboard { }) static onKeyboardHide(): Observable {return; } -} \ No newline at end of file +}