Add 'returns' and change h2 descriptions
This commit is contained in:
parent
624b6b9762
commit
714745cdd7
1 changed files with 16 additions and 2 deletions
|
@ -13,7 +13,7 @@ app.on('window-all-closed', function() {
|
||||||
|
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
The following are events on `app`.
|
The `app` object emits the following events:
|
||||||
|
|
||||||
### Event: 'will-finish-launching'
|
### Event: 'will-finish-launching'
|
||||||
|
|
||||||
|
@ -40,6 +40,8 @@ this case the `window-all-closed` event would not be emitted.
|
||||||
|
|
||||||
### Event: 'before-quit'
|
### Event: 'before-quit'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
|
|
||||||
Emitted before the application starts closing its windows.
|
Emitted before the application starts closing its windows.
|
||||||
|
@ -48,6 +50,8 @@ terminating the application.
|
||||||
|
|
||||||
### Event: 'will-quit'
|
### Event: 'will-quit'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
|
|
||||||
Emitted when all windows have been closed and the application will quit.
|
Emitted when all windows have been closed and the application will quit.
|
||||||
|
@ -62,6 +66,8 @@ Emitted when the application is quitting.
|
||||||
|
|
||||||
### Event: 'open-file'
|
### Event: 'open-file'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `path` String
|
* `path` String
|
||||||
|
|
||||||
|
@ -76,6 +82,8 @@ You should call `event.preventDefault()` if you want to handle this event.
|
||||||
|
|
||||||
### Event: 'open-url'
|
### Event: 'open-url'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `url` String
|
* `url` String
|
||||||
|
|
||||||
|
@ -92,6 +100,8 @@ clicks on the application's dock icon.
|
||||||
|
|
||||||
### Event: 'browser-window-blur'
|
### Event: 'browser-window-blur'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `window` BrowserWindow
|
* `window` BrowserWindow
|
||||||
|
|
||||||
|
@ -99,6 +109,8 @@ Emitted when a [browserWindow](browser-window.md) gets blurred.
|
||||||
|
|
||||||
### Event: 'browser-window-focus'
|
### Event: 'browser-window-focus'
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `window` BrowserWindow
|
* `window` BrowserWindow
|
||||||
|
|
||||||
|
@ -108,6 +120,8 @@ Emitted when a [browserWindow](browser-window.md) gets focused.
|
||||||
|
|
||||||
Emitted when a client certificate is requested.
|
Emitted when a client certificate is requested.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `webContents` [WebContents](browser-window.md#class-webcontents)
|
* `webContents` [WebContents](browser-window.md#class-webcontents)
|
||||||
* `url` String
|
* `url` String
|
||||||
|
@ -133,7 +147,7 @@ Emitted when the gpu process crashes.
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
The following are methods on the `app` class.
|
The `app` object has the following methods:
|
||||||
|
|
||||||
### `app.quit()`
|
### `app.quit()`
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue