Merge pull request #6934 from electron/add-missing-class-descriptions

Give every class a description
This commit is contained in:
Kevin Sawicki 2016-08-23 10:16:29 -07:00 committed by GitHub
commit 1276587ebe
3 changed files with 23 additions and 13 deletions

View file

@ -29,8 +29,8 @@ console.log(webContents)
### `webContents.getAllWebContents()`
Returns an array of all web contents. This will contain web contents for all
windows, webviews, opened devtools, and devtools extension background pages.
Returns an array of all `WebContents` instances. This will contain web contents
for all windows, webviews, opened devtools, and devtools extension background pages.
### `webContents.getFocusedWebContents()`
@ -39,6 +39,8 @@ returns `null`.
## Class: WebContents
> Render and control the contents of a BrowserWindow instance.
### Instance Events
#### Event: 'did-finish-load'
@ -1161,7 +1163,10 @@ Get the debugger instance for this webContents.
## Class: Debugger
Debugger API serves as an alternate transport for [remote debugging protocol][rdp].
> An alternate transport for Chrome's remote debugging protocol.
Chrome Developer Tools has a [special binding][rdp] available at JavaScript
runtime that allows interacting with pages and instrumenting them.
```javascript
const {BrowserWindow} = require('electron')