Cleanup docs and standardize structs

This commit is contained in:
Samuel Attard 2016-10-13 14:38:06 +11:00
parent 46cd8708a4
commit 78343a62b8
No known key found for this signature in database
GPG key ID: 273DC1869D8F13EF
5 changed files with 24 additions and 29 deletions

View file

@ -184,14 +184,7 @@ Returns:
* `webContents` [WebContents](web-contents.md) * `webContents` [WebContents](web-contents.md)
* `url` URL * `url` URL
* `error` String - The error code * `error` String - The error code
* `certificate` Object * `certificate` [Certificate](structures/certificate.md)
* `data` String - PEM encoded data
* `issuerName` String - Issuer's Common Name
* `subjectName` String - Subject's Common Name
* `serialNumber` String - Hex value represented string
* `validStart` Integer - Start date of the certificate being valid in seconds
* `validExpiry` Integer - End date of the certificate being valid in seconds
* `fingerprint` String - Fingerprint of the certificate
* `callback` Function * `callback` Function
Emitted when failed to verify the `certificate` for `url`, to trust the Emitted when failed to verify the `certificate` for `url`, to trust the

View file

@ -402,7 +402,7 @@ The following events are available on instances of `Cookies`:
#### Event: 'changed' #### Event: 'changed'
* `event` Event * `event` Event
* `cookie` Object - The cookie that was changed * `cookie` [Cookie](structures/cookie.md) - The cookie that was changed
* `cause` String - The cause of the change with one of the following values: * `cause` String - The cause of the change with one of the following values:
* `explicit` - The cookie was changed directly by a consumer's action. * `explicit` - The cookie was changed directly by a consumer's action.
* `overwrite` - The cookie was automatically removed due to an insert * `overwrite` - The cookie was automatically removed due to an insert
@ -436,21 +436,7 @@ The following methods are available on instances of `Cookies`:
Sends a request to get all cookies matching `details`, `callback` will be called Sends a request to get all cookies matching `details`, `callback` will be called
with `callback(error, cookies)` on complete. with `callback(error, cookies)` on complete.
`cookies` is an Array of `cookie` objects. `cookies` is an Array of [`cookie`](structures/cookie.md) objects.
* `cookie` Object
* `name` String - The name of the cookie.
* `value` String - The value of the cookie.
* `domain` String - The domain of the cookie.
* `hostOnly` String - Whether the cookie is a host-only cookie.
* `path` String - The path of the cookie.
* `secure` Boolean - Whether the cookie is marked as secure.
* `httpOnly` Boolean - Whether the cookie is marked as HTTP only.
* `session` Boolean - Whether the cookie is a session cookie or a persistent
cookie with an expiration date.
* `expirationDate` Double (optional) - The expiration date of the cookie as
the number of seconds since the UNIX epoch. Not provided for session
cookies.
#### `cookies.set(details, callback)` #### `cookies.set(details, callback)`

View file

@ -0,0 +1,4 @@
# Bluetooth Device Object
* `deviceName` String
* `deviceId` String

View file

@ -0,0 +1,14 @@
# Certificate Object
* `name` String - The name of the cookie.
* `value` String - The value of the cookie.
* `domain` String - The domain of the cookie.
* `hostOnly` String - Whether the cookie is a host-only cookie.
* `path` String - The path of the cookie.
* `secure` Boolean - Whether the cookie is marked as secure.
* `httpOnly` Boolean - Whether the cookie is marked as HTTP only.
* `session` Boolean - Whether the cookie is a session cookie or a persistent
cookie with an expiration date.
* `expirationDate` Double (optional) - The expiration date of the cookie as
the number of seconds since the UNIX epoch. Not provided for session
cookies.

View file

@ -147,7 +147,7 @@ Returns:
`new-window`, `save-to-disk` and `other`. `new-window`, `save-to-disk` and `other`.
* `options` Object - The options which will be used for creating the new * `options` Object - The options which will be used for creating the new
`BrowserWindow`. `BrowserWindow`.
* `additionalFeatures` Array - The non-standard features (features not handled * `additionalFeatures` String[] - The non-standard features (features not handled
by Chromium or Electron) given to `window.open()`. by Chromium or Electron) given to `window.open()`.
Emitted when the page requests to open a new window for a `url`. It could be Emitted when the page requests to open a new window for a `url`. It could be
@ -428,9 +428,7 @@ Emitted when there is a new context menu that needs to be handled.
Returns: Returns:
* `event` Event * `event` Event
* `devices` [Objects] * `devices` [BluetoothDevice[]](structures/bluetooth-device.md)
* `deviceName` String
* `deviceId` String
* `callback` Function * `callback` Function
* `deviceId` String * `deviceId` String
@ -1069,7 +1067,7 @@ End subscribing for frame presentation events.
#### `contents.startDrag(item)` #### `contents.startDrag(item)`
* `item` object * `item` Object
* `file` String * `file` String
* `icon` [NativeImage](native-image.md) * `icon` [NativeImage](native-image.md)