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

Update formatting to prevent '[] ()' sequences (e.g. String[] (optional)), which breaks MD rendering on GitHub and hides the array indication

Browse source
This commit is contained in:
George Hafiz 2016-11-18 00:34:48 +00:00
parent 3834f0c6a6
commit aac31159b8
6 changed files with 11 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

@ -321,7 +321,7 @@ and `will-quit` events will not be emitted.
### `app.relaunch([options])` ### `app.relaunch([options])`
* `options` Object (optional) * `options` Object (optional)
* `args` String[] (optional) * `args` String[] - (optional)
* `execPath` String (optional) * `execPath` String (optional)
Relaunches the app when current instance exits. Relaunches the app when current instance exits.
@ -462,7 +462,7 @@ Clears the recent documents list.
app to handle `electron://` links, call this method with `electron` as the app to handle `electron://` links, call this method with `electron` as the
parameter. parameter.
* `path` String (optional) _Windows_ - Defaults to `process.execPath` * `path` String (optional) _Windows_ - Defaults to `process.execPath`
* `args` String[] (optional) _Windows_ - Defaults to an empty array * `args` String[] - (optional) _Windows_ - Defaults to an empty array
Returns `Boolean` - Whether the call succeeded. Returns `Boolean` - Whether the call succeeded.
@ -486,7 +486,7 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
* `protocol` String - The name of your protocol, without `://`. * `protocol` String - The name of your protocol, without `://`.
* `path` String (optional) _Windows_ - Defaults to `process.execPath` * `path` String (optional) _Windows_ - Defaults to `process.execPath`
* `args` String[] (optional) _Windows_ - Defaults to an empty array * `args` String[] - (optional) _Windows_ - Defaults to an empty array
Returns `Boolean` - Whether the call succeeded. Returns `Boolean` - Whether the call succeeded.
@ -498,7 +498,7 @@ protocol (aka URI scheme). If so, it will remove the app as the default handler.
* `protocol` String - The name of your protocol, without `://`. * `protocol` String - The name of your protocol, without `://`.
* `path` String (optional) _Windows_ - Defaults to `process.execPath` * `path` String (optional) _Windows_ - Defaults to `process.execPath`
* `args` String[] (optional) _Windows_ - Defaults to an empty array * `args` String[] - (optional) _Windows_ - Defaults to an empty array
Returns `Boolean` Returns `Boolean`

4
docs/api/browser-window.md
View file

@ -973,7 +973,7 @@ Same as `webContents.capturePage([rect, ]callback)`.
* `httpReferrer` String (optional) - A HTTP Referrer url. * `httpReferrer` String (optional) - A HTTP Referrer url.
* `userAgent` String (optional) - A user agent originating the request. * `userAgent` String (optional) - A user agent originating the request.
* `extraHeaders` String (optional) - Extra headers separated by "\n" * `extraHeaders` String (optional) - Extra headers separated by "\n"
* `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional)
Same as `webContents.loadURL(url[, options])`. Same as `webContents.loadURL(url[, options])`.
@ -1071,7 +1071,7 @@ The `buttons` is an array of `Button` objects:
toolbar. toolbar.
* `click` Function * `click` Function
* `tooltip` String (optional) - The text of the button's tooltip. * `tooltip` String (optional) - The text of the button's tooltip.
* `flags` String[] (optional) - Control specific states and behaviors of the * `flags` String[] - (optional) - Control specific states and behaviors of the
button. By default, it is `['enabled']`. button. By default, it is `['enabled']`.
The `flags` is an array that can include following `String`s: The `flags` is an array that can include following `String`s:

4
docs/api/dialog.md
View file

@ -32,7 +32,7 @@ The `dialog` module has the following methods:
* `buttonLabel` String (optional) - Custom label for the confirmation button, when * `buttonLabel` String (optional) - Custom label for the confirmation button, when
left empty the default label will be used. left empty the default label will be used.
* `filters` [FileFilter[]](structrs/file-filter.md) (optional) * `filters` [FileFilter[]](structrs/file-filter.md) (optional)
* `properties` String[] (optional) - Contains which features the dialog should use, can * `properties` String[] - (optional) - Contains which features the dialog should use, can
contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory` contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory`
and `showHiddenFiles`. and `showHiddenFiles`.
* `callback` Function (optional) * `callback` Function (optional)
@ -95,7 +95,7 @@ will be passed via `callback(filename)`
* `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or * `type` String (optional) - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"warning"`. On Windows, "question" displays the same icon as "info", unless `"warning"`. On Windows, "question" displays the same icon as "info", unless
you set an icon using the "icon" option. you set an icon using the "icon" option.
* `buttons` String[] (optional) - Array of texts for buttons. On Windows, an empty array * `buttons` String[] - (optional) - Array of texts for buttons. On Windows, an empty array
will result in one button labeled "OK". will result in one button labeled "OK".
* `defaultId` Integer (optional) - Index of the button in the buttons array which will * `defaultId` Integer (optional) - Index of the button in the buttons array which will
be selected by default when the message box opens. be selected by default when the message box opens.

2
docs/api/structures/thumbar-button.md
View file

@ -4,7 +4,7 @@
toolbar. toolbar.
* `click` Function * `click` Function
* `tooltip` String (optional) - The text of the button's tooltip. * `tooltip` String (optional) - The text of the button's tooltip.
* `flags` String[] (optional) - Control specific states and behaviors of the * `flags` String[] - (optional) - Control specific states and behaviors of the
button. By default, it is `['enabled']`. button. By default, it is `['enabled']`.
The `flags` is an array that can include following `String`s: The `flags` is an array that can include following `String`s:

2
docs/api/web-contents.md
View file

@ -490,7 +490,7 @@ win.loadURL('http://github.com')
* `httpReferrer` String (optional) - A HTTP Referrer url. * `httpReferrer` String (optional) - A HTTP Referrer url.
* `userAgent` String (optional) - A user agent originating the request. * `userAgent` String (optional) - A user agent originating the request.
* `extraHeaders` String (optional) - Extra headers separated by "\n" * `extraHeaders` String (optional) - Extra headers separated by "\n"
* `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional)
Loads the `url` in the window. The `url` must contain the protocol prefix, Loads the `url` in the window. The `url` must contain the protocol prefix,
e.g. the `http://` or `file://`. If the load should bypass http cache then e.g. the `http://` or `file://`. If the load should bypass http cache then

2
docs/api/web-view-tag.md
View file

@ -303,7 +303,7 @@ webview.addEventListener('dom-ready', () => {
* `httpReferrer` String (optional) - A HTTP Referrer url. * `httpReferrer` String (optional) - A HTTP Referrer url.
* `userAgent` String (optional) - A user agent originating the request. * `userAgent` String (optional) - A user agent originating the request.
* `extraHeaders` String (optional) - Extra headers separated by "\n" * `extraHeaders` String (optional) - Extra headers separated by "\n"
* `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] (optional) * `postData` ([UploadRawData](structures/upload-raw-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[] - (optional)
Loads the `url` in the webview, the `url` must contain the protocol prefix, Loads the `url` in the webview, the `url` must contain the protocol prefix,
e.g. the `http://` or `file://`. e.g. the `http://` or `file://`.