Browse Source

docs: fix platform location for params (#18987)

Shelley Vohr 5 years ago
parent
commit
1a6a16e346
4 changed files with 9 additions and 11 deletions
  1. 4 4
      docs/api/app.md
  2. 1 1
      docs/api/menu-item.md
  3. 2 3
      docs/api/shell.md
  4. 2 3
      docs/api/structures/process-memory-info.md

+ 4 - 4
docs/api/app.md

@@ -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.
   * `copyright` String (optional) - Copyright information.
   * `version` String (optional) - The app's build version number.
-  * `credits` String (optional) - Credit information. _macOS_
-  * `authors` String[] (optional) - List of app authors. _Linux_
-  * `website` String (optional) - The app's website. _Linux_
-  * `iconPath` String (optional) - Path to the app's icon. Will be shown as 64x64 pixels while retaining aspect ratio. _Linux_
+  * `credits` String (optional) _macOS_ - Credit information.
+  * `authors` String[] (optional) _Linux_ - List of app authors.
+  * `website` String (optional) _Linux_ - The app's website.
+  * `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
 `.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.

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

@@ -24,7 +24,7 @@ See [`Menu`](menu.md) for examples.
   * `icon` ([NativeImage](native-image.md) | String) (optional)
   * `enabled` Boolean (optional) - If false, the menu item will be greyed out and
     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.
   * `checked` Boolean (optional) - Should only be specified for `checkbox` or `radio` type
     menu items.

+ 2 - 3
docs/api/shell.md

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

+ 2 - 3
docs/api/structures/process-memory-info.md

@@ -1,8 +1,7 @@
 # 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.
-* `private` Integer - The amount of memory not shared by other processes, such as
-  JS heap or HTML content in Kilobytes.
+* `private` Integer - The amount of memory not shared by other processes, such as JS heap or HTML content in Kilobytes.
 * `shared` Integer - The amount of memory shared between processes, typically
   memory consumed by the Electron code itself in Kilobytes.