Skip to content

Commit 25f04d5

Browse files
committed
Fix descriptions to make docs parser happy
1 parent 88b887f commit 25f04d5

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

docs/api/web-frame.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Process: [Renderer](../glossary.md#renderer-process)
66

77
`webFrame` export of the electron module is an instance of the `WebFrame`
88
class representing the top frame of the current `BrowserWindow`. Sub-frames can
9-
be retrieved by certain properties and methods (e.g. `webFrame.firstChild`)
9+
be retrieved by certain properties and methods (e.g. `webFrame.firstChild`).
1010

1111
An example of zooming current page to 200%.
1212

@@ -221,46 +221,46 @@ and intend to stay there).
221221

222222
### `webFrame.getFrameForSelector(selector)`
223223

224-
* Returns `WebFrame` for the frame element in `webFrame's` document selected by
225-
`selector`
226-
* Returns `null` if `selector` does not select a frame or if the frame is not in
227-
the current renderer process.
228-
* `selector` String - CSS selector for a frame element
224+
* `selector` String - CSS selector for a frame element.
229225

226+
Returns `WebFrame` - The frame element in `webFrame's` document selected by
227+
`selector`, `null` would be returned if `selector` does not select a frame or
228+
if the frame is not in the current renderer process.
230229

231230
### `webFrame.findFrameByName(name)`
232231

233-
* Returns `WebFrame` - a child of `webFrame` with the supplied `name`
234-
* Returns `null` if there's no such frame or if the frame is not in the current
235-
renderer process.
232+
* `name` String
233+
234+
Returns `WebFrame` - A child of `webFrame` with the supplied `name`, `null`
235+
would be returned if there's no such frame or if the frame is not in the current
236+
renderer process.
236237

237238
## Properties
238239

239240
### `webFrame.top`
240241

241-
* Returns `WebFrame` - top frame in frame hierarchy to which `webFrame` belongs
242-
* Returns `null` if top frame is not in the current renderer process.
242+
A `WebFrame` representing top frame in frame hierarchy to which `webFrame`
243+
belongs, the property would be `null` if top frame is not in the current
244+
renderer process.
243245

244246
### `webFrame.opener`
245247

246-
* Returns `WebFrame` - frame which opened `webFrame`
247-
* Returns `null` if there's no opener or opener is not in the current renderer
248-
process.
248+
A `WebFrame` representing the frame which opened `webFrame`, the property would
249+
be `null` if there's no opener or opener is not in the current renderer process.
249250

250251
### `webFrame.parent`
251252

252-
* Returns `WebFrame` - parent frame of `webFrame`
253-
* Returns `null` if `webFrame` is top or parent is not in the current renderer
254-
process.
253+
A `WebFrame` representing parent frame of `webFrame`, the property would be
254+
`null` if `webFrame` is top or parent is not in the current renderer process.
255255

256256
### `webFrame.firstChild`
257257

258-
* Returns `WebFrame` - first child frame of `webFrame`
259-
* Returns `null` if `webFrame` has no children or if first child is not in the
260-
current renderer process.
258+
A `WebFrame` representing the first child frame of `webFrame`, the property
259+
would be `null` if `webFrame` has no children or if first child is not in the
260+
current renderer process.
261261

262262
### `webFrame.nextSibling`
263263

264-
* Returns `WebFrame` - next sibling frame
265-
* Returns `null` if `webFrame` is the last frame its parent or if the next
266-
sibling is not in the current renderer process.
264+
A `WebFrame` representing next sibling frame, the property would be `null` if
265+
`webFrame` is the last frame its parent or if the next sibling is not in the
266+
current renderer process.

0 commit comments

Comments
 (0)