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

docs: add support for readonly,deprecated and platform doc annotations (#19478)

Browse source
This commit is contained in:
Samuel Attard 2019-07-26 16:12:59 -07:00 • committed by GitHub
parent 12bbbef688
commit db3cf52add
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 53 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/api/web-frame.md
View file

@ -228,35 +228,35 @@ Returns `WebFrame` - that has the supplied `routingId`, `null` if not found.
## Properties
### `webFrame.top`
### `webFrame.top` _Readonly_
A `WebFrame` representing top frame in frame hierarchy to which `webFrame`
A `WebFrame | null` representing top frame in frame hierarchy to which `webFrame`
belongs, the property would be `null` if top frame is not in the current
renderer process.
### `webFrame.opener`
### `webFrame.opener` _Readonly_
A `WebFrame` representing the frame which opened `webFrame`, the property would
A `WebFrame | null` representing the frame which opened `webFrame`, the property would
be `null` if there's no opener or opener is not in the current renderer process.
### `webFrame.parent`
### `webFrame.parent` _Readonly_
A `WebFrame` representing parent frame of `webFrame`, the property would be
A `WebFrame | null` representing parent frame of `webFrame`, the property would be
`null` if `webFrame` is top or parent is not in the current renderer process.
### `webFrame.firstChild`
### `webFrame.firstChild` _Readonly_
A `WebFrame` representing the first child frame of `webFrame`, the property
A `WebFrame | null` representing the first child frame of `webFrame`, the property
would be `null` if `webFrame` has no children or if first child is not in the
current renderer process.
### `webFrame.nextSibling`
### `webFrame.nextSibling` _Readonly_
A `WebFrame` representing next sibling frame, the property would be `null` if
A `WebFrame | null` representing next sibling frame, the property would be `null` if
`webFrame` is the last frame in its parent or if the next sibling is not in the
current renderer process.
### `webFrame.routingId`
### `webFrame.routingId` _Readonly_
An `Integer` representing the unique frame id in the current renderer process.
Distinct WebFrame instances that refer to the same underlying frame will have