From 25f04d5b03690913e2baf41fab5c5c19e72d45cd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 26 Feb 2018 15:05:46 +0900 Subject: [PATCH] Fix descriptions to make docs parser happy --- docs/api/web-frame.md | 46 +++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index d2704d53d49b..cc7ab360600f 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -6,7 +6,7 @@ Process: [Renderer](../glossary.md#renderer-process) `webFrame` export of the electron module is an instance of the `WebFrame` class representing the top frame of the current `BrowserWindow`. Sub-frames can -be retrieved by certain properties and methods (e.g. `webFrame.firstChild`) +be retrieved by certain properties and methods (e.g. `webFrame.firstChild`). An example of zooming current page to 200%. @@ -221,46 +221,46 @@ and intend to stay there). ### `webFrame.getFrameForSelector(selector)` -* Returns `WebFrame` for the frame element in `webFrame's` document selected by - `selector` -* Returns `null` if `selector` does not select a frame or if the frame is not in - the current renderer process. -* `selector` String - CSS selector for a frame element +* `selector` String - CSS selector for a frame element. +Returns `WebFrame` - The frame element in `webFrame's` document selected by +`selector`, `null` would be returned if `selector` does not select a frame or +if the frame is not in the current renderer process. ### `webFrame.findFrameByName(name)` -* Returns `WebFrame` - a child of `webFrame` with the supplied `name` -* Returns `null` if there's no such frame or if the frame is not in the current - renderer process. +* `name` String + +Returns `WebFrame` - A child of `webFrame` with the supplied `name`, `null` +would be returned if there's no such frame or if the frame is not in the current +renderer process. ## Properties ### `webFrame.top` -* Returns `WebFrame` - top frame in frame hierarchy to which `webFrame` belongs -* Returns `null` if top frame is not in the current renderer process. +A `WebFrame` 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` -* Returns `WebFrame` - frame which opened `webFrame` -* Returns `null` if there's no opener or opener is not in the current renderer - process. +A `WebFrame` 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` -* Returns `WebFrame` - parent frame of `webFrame` -* Returns `null` if `webFrame` is top or parent is not in the current renderer - process. +A `WebFrame` 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` -* Returns `WebFrame` - first child frame of `webFrame` -* Returns `null` if `webFrame` has no children or if first child is not in the - current renderer process. +A `WebFrame` 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` -* Returns `WebFrame` - next sibling frame -* Returns `null` if `webFrame` is the last frame its parent or if the next - sibling is not in the current renderer process. +A `WebFrame` representing next sibling frame, the property would be `null` if +`webFrame` is the last frame its parent or if the next sibling is not in the +current renderer process.