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

document some missing parameters

Browse source
This commit is contained in:
Zeke Sikelianos 2016-08-25 14:43:06 -07:00
parent 0e4e60625f
commit 5619558689
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api/shell.md
View file

@ -78,7 +78,9 @@ returned, otherwise `false` is returned.
### `shell.readShortcutLink(shortcutPath)` _Windows_ ### `shell.readShortcutLink(shortcutPath)` _Windows_
Resolves the shortcut link at `shortcutPath`, an object is returned with the - `shortcutPath` String
Resolves the shortcut link at `shortcutPath`. An object is returned with the
fields described in the `options` of `shell.writeShortcutLink`. fields described in the `options` of `shell.writeShortcutLink`.
An exception will be thrown when any error happens. An exception will be thrown when any error happens.

8
docs/api/tray.md
View file

@ -185,11 +185,11 @@ Sets the title displayed aside of the tray icon in the status bar.
#### `tray.setHighlightMode(mode)` _macOS_ #### `tray.setHighlightMode(mode)` _macOS_
* `mode` String highlight mode with one of the following values: * `mode` String - highlight mode with one of the following values:
* `'selection'` - Highlight the tray icon when it is clicked and also when * `selection` - Highlight the tray icon when it is clicked and also when
its context menu is open. This is the default. its context menu is open. This is the default.
* `'always'` - Always highlight the tray icon. * `always` - Always highlight the tray icon.
* `'never'` - Never highlight the tray icon. * `never` - Never highlight the tray icon.
Sets when the tray's icon background becomes highlighted (in blue). Sets when the tray's icon background becomes highlighted (in blue).

2
docs/api/web-contents.md
View file

@ -1128,6 +1128,8 @@ If *offscreen rendering* is enabled returns whether it is currently painting.
#### `contents.setFrameRate(fps)` #### `contents.setFrameRate(fps)`
* `fps` Integer
If *offscreen rendering* is enabled sets the frame rate to the specified number. If *offscreen rendering* is enabled sets the frame rate to the specified number.
Only values between 1 and 60 are accepted. Only values between 1 and 60 are accepted.