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

Merge pull request #2750 from atom/jl-doc-bits

Browse source 
A Few More Documentation Things
This commit is contained in:
Jessica Lord 2015-09-10 10:41:42 -07:00
commit b861a174ca
17 changed files with 79 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -117,7 +117,7 @@ Properties `width` and `height` are required.
The `BrowserWindow` object emits the following events:
+**Note** Some events are only available on specific operating systems and are labeled as such.
+**Note:** Some events are only available on specific operating systems and are labeled as such.
### Event: 'page-title-updated'
@ -224,15 +224,15 @@ Emitted when the window leaves full screen state triggered by html api.
### Event: 'devtools-opened'
Emitted when devtools is opened.
Emitted when DevTools is opened.
### Event: 'devtools-closed'
Emitted when devtools is closed.
Emitted when DevTools is closed.
### Event: 'devtools-focused'
Emitted when devtools is focused / opened.
Emitted when DevTools is focused / opened.
### Event: 'app-command' _Windows_
@ -277,7 +277,7 @@ Find a window according to its ID.
* `path` String
Adds devtools extension located at `path`, and returns extension's name.
Adds DevTools extension located at `path`, and returns extension's name.
The extension will be remembered so you only need to call this API once, this
API is not for programming use.
@ -286,13 +286,13 @@ API is not for programming use.
* `name` String
Remove the devtools extension whose name is `name`.
Remove the DevTools extension whose name is `name`.
## Instance Methods
Objects created with `new BrowserWindow` have the following instance methods:
+**Note** Some methods are only available on specific operating systems and are labeled as such.
+**Note:** Some methods are only available on specific operating systems and are labeled as such.
```javascript
var BrowserWindow = require('browser-window');
@ -315,10 +315,10 @@ when the renderer process (web page) has crashed.
### `win.devToolsWebContents()`
Get the `WebContents` of devtools for this window.
Get the `WebContents` of DevTools for this window.
**Note:** Users should never store this object because it may become `null`
when the devtools has been closed.
when the DevTools has been closed.
### `win.id()`
@ -577,7 +577,7 @@ Whether the window's document has been edited.
### `win.openDevTools([options])`
* `options` Object (optional). Properties:
* `detach` Boolean - opens devtools in a new window
* `detach` Boolean - opens DevTools in a new window
Opens the developer tools.