From 2c7ccffe1aeee3adc72231dbb7b004a1516bc43b Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:16:20 -0700 Subject: [PATCH] Line wrap at 80-col --- docs/api/clipboard.md | 3 ++- docs/api/content-tracing.md | 19 +++++++++++++------ docs/api/crash-reporter.md | 19 +++++++++++++------ 3 files changed, 28 insertions(+), 13 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index c66b8c839f..030c2e4769 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,6 +1,7 @@ # clipboard -The `clipboard` object provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard: +The `clipboard` object provides methods to perform copy and paste operations. +The following example shows how to write a string to the clipboard: ```javascript var clipboard = require('clipboard'); diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 85dc313001..264eda975d 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -29,7 +29,8 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { Get a set of category groups. The category groups can change as new code paths are reached. -Once all child processes have acked to the `getCategories` request, `callback` is invoked with an array of category groups. +Once all child processes have acked to the `getCategories` request, `callback` +is invoked with an array of category groups. ### `tracing.startRecording(categoryFilter, traceOptions, callback)` @@ -81,7 +82,8 @@ Stop recording on all processes. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid runtime overhead of tracing. So, to end tracing, we must asynchronously ask all +operation to send the trace data over IPC, and we would like to avoid runtime +overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. Once all child processes have acked to the `stopRecording` request, `callback` @@ -111,7 +113,8 @@ Once all child processes have acked to the `startMonitoring` request the Stop monitoring on all processes. -Once all child processes have acked to the `stopMonitoring` request the `callback` is called. +Once all child processes have acked to the `stopMonitoring` request the +`callback` is called. ### `tracing.captureMonitoringSnapshot(resultFilePath, callback)` @@ -123,16 +126,20 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive operation to send the trace data over IPC and we would like to avoid unneeded -runtime overhead from tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. +runtime overhead from tracing. So, to end tracing, we must asynchronously ask +all child processes to flush any pending trace data. -Once all child processes have acked to the `captureMonitoringSnapshot` request the `callback` will be called with a file that contains the traced data. +Once all child processes have acked to the `captureMonitoringSnapshot` request +the `callback` will be called with a file that contains the traced data. ### `tracing.getTraceBufferUsage(callback)` * `callback` Function -Get the maximum usage across processes of trace buffer as a percentage of the full state. When the TraceBufferUsage value is determined the `callback` is called. +Get the maximum usage across processes of trace buffer as a percentage of the +full state. When the TraceBufferUsage value is determined the `callback` is +called. ### `tracing.setWatchEvent(categoryName, eventName, callback)` diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index c7f2f20f4f..cf000db1fc 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -2,7 +2,8 @@ The `crash-reporter` module enables sending your app's crash reports. -The following is an example of automatically submitting a crash report to a remote server: +The following is an example of automatically submitting a crash report to a +remote server: ```javascript crashReporter = require('crash-reporter'); @@ -33,11 +34,14 @@ The `crash-reporter` module has the following methods: * Only string properties are sent correctly. * Nested objects are not supported. -Developers are required to call this method before using other `crashReporter` APIs. +Developers are required to call this method before using other `crashReporter` +APIs. **Note:** On OS X, Electron uses a new `crashpad` client, which is different from `breakpad` on Windows and Linux. To enable the crash collection feature, -you are required to call the `crashReporter.start` API to initialize `crashpad` in the main process and in each renderer process from which you wish to collect crash reports. +you are required to call the `crashReporter.start` API to initialize `crashpad` +in the main process and in each renderer process from which you wish to collect +crash reports. ### `crashReporter.getLastCrashReport()` @@ -58,8 +62,11 @@ The crash reporter will send the following data to the `submitUrl` as `POST`: * `process_type` String - e.g. 'renderer' * `ptime` Number * `_version` String - The version in `package.json` -* `_productName` String - The product name in the `crashReporter` `options` object +* `_productName` String - The product name in the `crashReporter` `options` + object * `prod` String - Name of the underlying product. In this case Electron -* `_companyName` String - The company name in the `crashReporter` `options` object +* `_companyName` String - The company name in the `crashReporter` `options` + object * `upload_file_minidump` File - The crashreport as file -* All level one properties of the `extra` object in the `crashReporter` `options` object +* All level one properties of the `extra` object in the `crashReporter` + `options` object