Browse Source

Fix tray and menu docs

Samuel Attard 8 years ago
parent
commit
11f8923c43
3 changed files with 6 additions and 4 deletions
  1. 1 1
      docs/api/menu-item.md
  2. 4 2
      docs/api/menu.md
  3. 1 1
      docs/api/tray.md

+ 1 - 1
docs/api/menu-item.md

@@ -31,7 +31,7 @@ Create a new `MenuItem` with the following method:
   * `visible` Boolean - (optional) If false, the menu item will be entirely hidden.
   * `checked` Boolean - (optional) Should only be specified for `checkbox` or `radio` type
     menu items.
-  * `submenu` Menu - (optional) Should be specified for `submenu` type menu items. If
+  * `submenu` MenuItemConstructorOptions[] - (optional) Should be specified for `submenu` type menu items. If
     `submenu` is specified, the `type: 'submenu'` can be omitted. If the value
     is not a `Menu` then it will be automatically converted to one using
     `Menu.buildFromTemplate`.

+ 4 - 2
docs/api/menu.md

@@ -238,7 +238,7 @@ will be set as each window's top menu.
 
 #### `Menu.getApplicationMenu()`
 
-Returns the application menu (an instance of `Menu`), if set, or `null`, if not set.
+Returns `Menu` the application menu (an instance of `Menu`), if set, or `null`, if not set.
 
 #### `Menu.sendActionToFirstResponder(action)` _macOS_
 
@@ -253,7 +253,9 @@ for more information on macOS' native actions.
 
 #### `Menu.buildFromTemplate(template)`
 
-* `template` MenuItem[]
+* `template` MenuItemConstructorOptions[]
+
+Returns `Menu`
 
 Generally, the `template` is just an array of `options` for constructing a
 [MenuItem](menu-item.md). The usage can be referenced above.

+ 1 - 1
docs/api/tray.md

@@ -57,7 +57,7 @@ rely on the `click` event and always attach a context menu to the tray icon.
 
 ### `new Tray(image)`
 
-* `image` [NativeImage](native-image.md)
+* `image` ([NativeImage](native-image.md) | String)
 
 Creates a new tray icon associated with the `image`.