github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-08 23:18:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document the return values of all methods in the docs

Browse Source
This commit is contained in:
Samuel Attard
2016-09-25 12:59:30 +13:00
committed by Samuel Attard
parent bf88fe32fd
commit d2a701a465
22 changed files with 276 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/power-save-blocker.md
View File

@@ -26,6 +26,8 @@ The `powerSaveBlocker` module has the following methods:
* `prevent-display-sleep` - Prevent the display from going to sleep. Keeps
system and screen active. Example use case: playing video.
Returns `Integer` - The blocker ID that is assigned to this power blocker
Starts preventing the system from entering lower-power mode. Returns an integer
identifying the power save blocker.
@@ -49,4 +51,4 @@ Stops the specified power save blocker.
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.
Returns a boolean whether the corresponding `powerSaveBlocker` has started.
Returns `Boolean` - Whether the corresponding `powerSaveBlocker` has started.