mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

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

14
docs/api/screen.md
View file

@ -106,15 +106,19 @@ The `screen` module has the following methods:
### `screen.getCursorScreenPoint()`
Returns the current absolute position of the mouse pointer.
Returns `Object`:
* `x` Integer
* `y` Integer
The current absolute position of the mouse pointer.
### `screen.getPrimaryDisplay()`
Returns the primary display.
Returns `Display` - The primary display.
### `screen.getAllDisplays()`
Returns an array of displays that are currently available.
Returns `Display[]` - An array of displays that are currently available.
### `screen.getDisplayNearestPoint(point)`
@ -122,7 +126,7 @@ Returns an array of displays that are currently available.
* `x` Integer
* `y` Integer
Returns the display nearest the specified point.
Returns `Display` - The display nearest the specified point.
### `screen.getDisplayMatching(rect)`
@ -132,4 +136,4 @@ Returns the display nearest the specified point.
* `width` Integer
* `height` Integer
Returns the display that most closely intersects the provided bounds.
Returns `Display` - The display that most closely intersects the provided bounds.