docs(): improve docs (#1813)
* Improve method description grammar * Fix some doc typos (#1) * Fix doc
This commit is contained in:
parent
3d387798b6
commit
f1dd8d61f5
@ -19,14 +19,14 @@ export interface BackgroundModeConfiguration {
|
|||||||
text?: String;
|
text?: String;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This will look for <icon name>.png in platforms/android/res/drawable|mipmap
|
* This will look for `<icon name>.png` in platforms/android/res/drawable|mipmap
|
||||||
*/
|
*/
|
||||||
icon?: string;
|
icon?: string;
|
||||||
|
|
||||||
color?: string;
|
color?: string;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* By default the app will come to foreground when taping on the notification. If false, plugin wont come to foreground when tapped.
|
* By default the app will come to foreground when taping on the notification. If false, plugin won't come to foreground when tapped.
|
||||||
*/
|
*/
|
||||||
resume?: boolean;
|
resume?: boolean;
|
||||||
|
|
||||||
@ -50,7 +50,7 @@ export interface BackgroundModeConfiguration {
|
|||||||
* @name Background Mode
|
* @name Background Mode
|
||||||
* @description
|
* @description
|
||||||
* Cordova plugin to prevent the app from going to sleep while in background.
|
* Cordova plugin to prevent the app from going to sleep while in background.
|
||||||
* Requires Cordova plugin: cordova-plugin-background-mode. For more info about plugin, vist: https://github.com/katzer/cordova-plugin-background-mode
|
* Requires Cordova plugin: cordova-plugin-background-mode. For more info about plugin, visit: https://github.com/katzer/cordova-plugin-background-mode
|
||||||
*@usage
|
*@usage
|
||||||
* ```typescript
|
* ```typescript
|
||||||
* import { BackgroundMode } from '@ionic-native/background-mode';
|
* import { BackgroundMode } from '@ionic-native/background-mode';
|
||||||
@ -179,7 +179,7 @@ export class BackgroundMode extends IonicNativePlugin {
|
|||||||
overrideBackButton(): void { }
|
overrideBackButton(): void { }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Exclude the app from the recent task list works on Android 5.0+.
|
* Exclude the app from the recent task list. Works on Android 5.0+.
|
||||||
*/
|
*/
|
||||||
@Cordova({
|
@Cordova({
|
||||||
platforms: ['Android'],
|
platforms: ['Android'],
|
||||||
|
Loading…
x
Reference in New Issue
Block a user