From 11f8923c4341f6da81122dbf628dadc42a2e80fa Mon Sep 17 00:00:00 2001 From: Samuel Attard Date: Mon, 7 Nov 2016 17:43:55 +1100 Subject: [PATCH] Fix tray and menu docs --- docs/api/menu-item.md | 2 +- docs/api/menu.md | 6 ++++-- docs/api/tray.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index c92df17..90d5747 100644 --- a/docs/api/menu-item.md +++ b/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`. diff --git a/docs/api/menu.md b/docs/api/menu.md index d5446f4..3d98618 100644 --- a/docs/api/menu.md +++ b/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. diff --git a/docs/api/tray.md b/docs/api/tray.md index 6353c47..660d703 100644 --- a/docs/api/tray.md +++ b/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`. -- 2.7.4