Merge pull request electron#8238 from electron/doc-links

Link to return class type
LarryKlugerDS · Dec 19, 2016 · 78a89c6 · 78a89c6
2 parents 683d803 + 6352afb
commit 78a89c6
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 10 deletions.
diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md
@@ -56,7 +56,7 @@ Writes `markup` to the clipboard.
 
 * `type` String (optional)
 
-Returns `NativeImage` - The content in the clipboard as a [NativeImage](native-image.md).
+Returns [`NativeImage`](native-image.md) - The image content in the clipboard.
 
 ### `clipboard.writeImage(image[, type])`
 

diff --git a/docs/api/net.md b/docs/api/net.md
@@ -63,7 +63,7 @@ The `net` module has the following methods:
 
 * `options` (Object | String) - The `ClientRequest` constructor options.
 
-Returns `ClientRequest`
+Returns [`ClientRequest`](./client-request.md)
 
 Creates a [`ClientRequest`](./client-request.md) instance using the provided
 `options` which are directly forwarded to the `ClientRequest` constructor.

diff --git a/docs/api/remote.md b/docs/api/remote.md
@@ -144,12 +144,12 @@ Returns `any` - The object returned by `require(module)` in the main process.
 
 ### `remote.getCurrentWindow()`
 
-Returns `BrowserWindow` - The [`BrowserWindow`](browser-window.md) object to which this web page
+Returns [`BrowserWindow`](browser-window.md) - The window to which this web page
 belongs.
 
 ### `remote.getCurrentWebContents()`
 
-Returns `WebContents` - The [`WebContents`](web-contents.md) object of this web page.
+Returns [`WebContents`](web-contents.md) - The web contents of this web page.
 
 ### `remote.getGlobal(name)`
 

diff --git a/docs/api/screen.md b/docs/api/screen.md
@@ -100,22 +100,23 @@ The current absolute position of the mouse pointer.
 
 ### `screen.getPrimaryDisplay()`
 
-Returns `Display` - The primary display.
+Returns [`Display`](structures/display.md) - The primary display.
 
 ### `screen.getAllDisplays()`
 
-Returns `Display[]` - An array of displays that are currently available.
+Returns [`Display[]`](structures/display.md) - An array of displays that are currently available.
 
 ### `screen.getDisplayNearestPoint(point)`
 
 * `point` Object
   * `x` Integer
   * `y` Integer
 
-Returns `Display` - The display nearest the specified point.
+Returns [`Display`](structures/display.md) - The display nearest the specified point.
 
 ### `screen.getDisplayMatching(rect)`
 
 * `rect` [Rectangle](structures/rectangle.md)
 
-Returns `Display` - The display that most closely intersects the provided bounds.
+Returns `Display`](structures/display.md) - The display that most closely
+intersects the provided bounds.
diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md
@@ -581,7 +581,8 @@ Shows pop-up dictionary that searches the selected word on the page.
 
 ### `<webview>.getWebContents()`
 
-Returns `WebContents` - The [WebContents](web-contents.md) associated with this `webview`.
+Returns [`WebContents`](web-contents.md) - The web contents associated with
+this `webview`.
 
 ## DOM events
 

diff --git a/docs/api/window-open.md b/docs/api/window-open.md
@@ -20,7 +20,8 @@ string.
 * `frameName` String (optional)
 * `features` String (optional)
 
-Returns `BrowserWindowProxy` - Creates a new window and returns an instance of `BrowserWindowProxy` class.
+Returns [`BrowserWindowProxy`](browser-window-proxy.md) - Creates a new window
+and returns an instance of `BrowserWindowProxy` class.
 
 The `features` string follows the format of standard browser, but each feature
 has to be a field of `BrowserWindow`'s options.