From 21105271a4aa8f03363c43186940bf928aeddf63 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Thu, 3 Nov 2016 11:50:00 -0700 Subject: [PATCH] document processes for APIs nested in parent docs --- docs/api/native-image.md | 2 ++ docs/api/net.md | 4 ++++ docs/api/session.md | 6 ++++++ docs/api/web-contents.md | 4 ++++ docs/api/window-open.md | 2 ++ 5 files changed, 18 insertions(+) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 67cf4b108ea2..7ca8c18c489a 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -157,6 +157,8 @@ Creates a new `NativeImage` instance from `dataURL`. > Natively wrap images such as tray, dock, and application icons. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + ### Instance Methods The following methods are available on instances of the `NativeImage` class: diff --git a/docs/api/net.md b/docs/api/net.md index 6a6a9b1c3704..8e33d776a00c 100644 --- a/docs/api/net.md +++ b/docs/api/net.md @@ -74,6 +74,8 @@ specified protocol scheme in the `options` object. > Make HTTP/HTTPS requests. +Process: [Main](../tutorial/quick-start.md#main-process) + `ClientRequest` implements the [Writable Stream](https://nodejs.org/api/stream.html#stream_writable_streams) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). @@ -266,6 +268,8 @@ response object,it will emit the `aborted` event. > Handle responses to HTTP/HTTPS requests. +Process: [Main](../tutorial/quick-start.md#main-process) + `IncomingMessage` implements the [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). diff --git a/docs/api/session.md b/docs/api/session.md index 849e8bbb64d3..9b77ce3403a0 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -54,6 +54,8 @@ A `Session` object, the default session object of the app. > Get and set properties of a session. +Process: [Main](../tutorial/quick-start.md#main-process) + You can create a `Session` object in the `session` module: ```javascript @@ -377,6 +379,8 @@ app.on('ready', function () { > Query and modify a session's cookies. +Process: [Main](../tutorial/quick-start.md#main-process) + Instances of the `Cookies` class are accessed by using `cookies` property of a `Session`. @@ -482,6 +486,8 @@ Removes the cookies matching `url` and `name`, `callback` will called with > Intercept and modify the contents of a request at various stages of its lifetime. +Process: [Main](../tutorial/quick-start.md#main-process) + Instances of the `WebRequest` class are accessed by using the `webRequest` property of a `Session`. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 61bd21f20703..da1b89171465 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -49,6 +49,8 @@ Returns `WebContents` - A WebContents instance with the given ID. > Render and control the contents of a BrowserWindow instance. +Process: [Main](../tutorial/quick-start.md#main-process) + ### Instance Events #### Event: 'did-finish-load' @@ -1174,6 +1176,8 @@ A Debugger instance for this webContents. > An alternate transport for Chrome's remote debugging protocol. +Process: [Main](../tutorial/quick-start.md#main-process) + Chrome Developer Tools has a [special binding][rdp] available at JavaScript runtime that allows interacting with pages and instrumenting them. diff --git a/docs/api/window-open.md b/docs/api/window-open.md index 2c0d9cb45300..ef4b02d1b9be 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -45,6 +45,8 @@ origin preference. > Manipulate the child browser window +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + The `BrowserWindowProxy` object is returned from `window.open` and provides limited functionality with the child window.