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

docs: fix platform location for params (#18987)

Browse source
This commit is contained in:
Shelley Vohr 2019-06-27 14:51:18 -07:00 committed by GitHub
parent ec8697bcdc
commit 1a6a16e346
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/app.md
View file

@ -1179,10 +1179,10 @@ Show the app's about panel options. These options can be overridden with `app.se
* `applicationVersion` String (optional) - The app's version. * `applicationVersion` String (optional) - The app's version.
* `copyright` String (optional) - Copyright information. * `copyright` String (optional) - Copyright information.
* `version` String (optional) - The app's build version number. * `version` String (optional) - The app's build version number.
* `credits` String (optional) - Credit information. _macOS_ * `credits` String (optional) _macOS_ - Credit information.
* `authors` String[] (optional) - List of app authors. _Linux_ * `authors` String[] (optional) _Linux_ - List of app authors.
* `website` String (optional) - The app's website. _Linux_ * `website` String (optional) _Linux_ - The app's website.
* `iconPath` String (optional) - Path to the app's icon. Will be shown as 64x64 pixels while retaining aspect ratio. _Linux_ * `iconPath` String (optional) _Linux_ - Path to the app's icon. Will be shown as 64x64 pixels while retaining aspect ratio.
Set the about panel options. This will override the values defined in the app's Set the about panel options. This will override the values defined in the app's
`.plist` file on MacOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults. `.plist` file on MacOS. See the [Apple docs][about-panel-options] for more details. On Linux, values must be set in order to be shown; there are no defaults.

2
docs/api/menu-item.md
View file

@ -24,7 +24,7 @@ See [`Menu`](menu.md) for examples.
* `icon` ([NativeImage](native-image.md) | String) (optional) * `icon` ([NativeImage](native-image.md) | String) (optional)
* `enabled` Boolean (optional) - If false, the menu item will be greyed out and * `enabled` Boolean (optional) - If false, the menu item will be greyed out and
unclickable. unclickable.
* `acceleratorWorksWhenHidden` Boolean (optional) - default is `true`, and when `false` will prevent the accelerator from triggering the item if the item is not visible`. _macOS_ * `acceleratorWorksWhenHidden` Boolean (optional) _macOS_ - default is `true`, and when `false` will prevent the accelerator from triggering the item if the item is not visible`.
* `visible` Boolean (optional) - If false, the menu item will be entirely hidden. * `visible` Boolean (optional) - If false, the menu item will be entirely hidden.
* `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type * `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type
menu items. menu items.

5
docs/api/shell.md
View file

@ -36,9 +36,8 @@ Open the given file in the desktop's default manner.
* `url` String - Max 2081 characters on windows. * `url` String - Max 2081 characters on windows.
* `options` Object (optional) * `options` Object (optional)
* `activate` Boolean (optional) - `true` to bring the opened application to the * `activate` Boolean (optional) _macOS_ - `true` to bring the opened application to the foreground. The default is `true`.
foreground. The default is `true`. _macOS_ * `workingDirectory` String (optional) _Windows_ - The working directory.
* `workingDirectory` String (optional) - The working directory. _Windows_
Returns `Promise<void>` Returns `Promise<void>`

5
docs/api/structures/process-memory-info.md
View file

@ -1,8 +1,7 @@
# ProcessMemoryInfo Object # ProcessMemoryInfo Object
* `residentSet` Integer - _Linux_ and _Windows_ - The amount of memory * `residentSet` Integer _Linux_ _Windows_ - The amount of memory
currently pinned to actual physical RAM in Kilobytes. currently pinned to actual physical RAM in Kilobytes.
* `private` Integer - The amount of memory not shared by other processes, such as * `private` Integer - The amount of memory not shared by other processes, such as JS heap or HTML content in Kilobytes.
JS heap or HTML content in Kilobytes.
* `shared` Integer - The amount of memory shared between processes, typically * `shared` Integer - The amount of memory shared between processes, typically
memory consumed by the Electron code itself in Kilobytes. memory consumed by the Electron code itself in Kilobytes.