From 714745cdd7add683c54ad6bf2e1e82914aef3eae Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 19 Aug 2015 18:51:36 +0200 Subject: [PATCH] Add 'returns' and change h2 descriptions --- docs/api/app.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 2a625ec3c18e..6a54dba3021a 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -13,7 +13,7 @@ app.on('window-all-closed', function() { ## Events -The following are events on `app`. +The `app` object emits the following events: ### Event: 'will-finish-launching' @@ -40,6 +40,8 @@ this case the `window-all-closed` event would not be emitted. ### Event: 'before-quit' +Returns: + * `event` Event Emitted before the application starts closing its windows. @@ -48,6 +50,8 @@ terminating the application. ### Event: 'will-quit' +Returns: + * `event` Event 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' +Returns: + * `event` Event * `path` String @@ -76,6 +82,8 @@ You should call `event.preventDefault()` if you want to handle this event. ### Event: 'open-url' +Returns: + * `event` Event * `url` String @@ -92,6 +100,8 @@ clicks on the application's dock icon. ### Event: 'browser-window-blur' +Returns: + * `event` Event * `window` BrowserWindow @@ -99,6 +109,8 @@ Emitted when a [browserWindow](browser-window.md) gets blurred. ### Event: 'browser-window-focus' +Returns: + * `event` Event * `window` BrowserWindow @@ -108,6 +120,8 @@ Emitted when a [browserWindow](browser-window.md) gets focused. Emitted when a client certificate is requested. +Returns: + * `event` Event * `webContents` [WebContents](browser-window.md#class-webcontents) * `url` String @@ -133,7 +147,7 @@ Emitted when the gpu process crashes. ## Methods -The following are methods on the `app` class. +The `app` object has the following methods: ### `app.quit()`