docs(all): standardizes and adds return types, also some param fixes

This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
+4
View File
@@ -24,18 +24,21 @@ import { Plugin, Cordova } from './plugin';
export class PowerManagement {
/**
* Acquire a wakelock by calling this.
* @returns {Promise<any>}
*/
@Cordova()
static acquire(): Promise<any> {return; }
/**
* This acquires a partial wakelock, allowing the screen to be dimmed.
* @returns {Promise<any>}
*/
@Cordova()
static dim(): Promise<any> {return; }
/**
* Release the wakelock. It's important to do this when you're finished with the wakelock, to avoid unnecessary battery drain.
* @returns {Promise<any>}
*/
@Cordova()
static release(): Promise<any> {return; }
@@ -44,6 +47,7 @@ export class PowerManagement {
* By default, the plugin will automatically release a wakelock when your app is paused (e.g. when the screen is turned off, or the user switches to another app).
* It will reacquire the wakelock upon app resume. If you would prefer to disable this behaviour, you can use this function.
* @param set {boolean}
* @returns {Promise<any>}
*/
@Cordova()
static setReleaseOnPause(set: boolean): Promise<any> {return; }