Browse Source

Merge pull request #6985 from electron/more-parameter-fixes

More parameter fixes
Zeke Sikelianos 8 years ago
parent
commit
34e0f8c644
4 changed files with 12 additions and 6 deletions
  1. 3 1
      docs/api/shell.md
  2. 4 4
      docs/api/tray.md
  3. 3 1
      docs/api/web-contents.md
  4. 2 0
      docs/api/window-open.md

+ 3 - 1
docs/api/shell.md

@@ -78,7 +78,9 @@ returned, otherwise `false` is returned.
 
 ### `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`.
 
 An exception will be thrown when any error happens.

+ 4 - 4
docs/api/tray.md

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

+ 3 - 1
docs/api/web-contents.md

@@ -696,7 +696,7 @@ Executes the editing command `cut` in web page.
 
 Executes the editing command `copy` in web page.
 
-### `contents.copyImageAt(x, y)`
+#### `contents.copyImageAt(x, y)`
 
 * `x` Integer
 * `y` Integer
@@ -1128,6 +1128,8 @@ If *offscreen rendering* is enabled returns whether it is currently painting.
 
 #### `contents.setFrameRate(fps)`
 
+* `fps` Integer
+
 If *offscreen rendering* is enabled sets the frame rate to the specified number.
 Only values between 1 and 60 are accepted.
 

+ 2 - 0
docs/api/window-open.md

@@ -38,6 +38,8 @@ origin preference.
 
 ## Class: BrowserWindowProxy
 
+> Manipulate the child browser window
+
 The `BrowserWindowProxy` object is returned from `window.open` and provides
 limited functionality with the child window.