mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

First few docs made optional

Browse source
This commit is contained in:
Samuel Attard 2016-10-30 21:46:20 +11:00 • committed by Zeke Sikelianos
parent 8a29604f1e
commit 1a9b4b4671
6 changed files with 105 additions and 166 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/api/crash-reporter.md
View file

@ -37,13 +37,13 @@ The `crash-reporter` module has the following methods:
### `crashReporter.start(options)`
* `options` Object
* `companyName` String
* `companyName` String (optional)
* `submitURL` String - URL that crash reports will be sent to as POST.
* `productName` String (optional) - Defaults to `app.getName()`.
* `autoSubmit` Boolean - Send the crash report without user interaction.
* `autoSubmit` Boolean (optional) - Send the crash report without user interaction.
Default is `true`.
* `ignoreSystemCrashHandler` Boolean - Default is `false`.
* `extra` Object - An object you can define that will be sent along with the
* `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
* `extra` Object (optional) - An object you can define that will be sent along with the
report. Only string properties are sent correctly, Nested objects are not
supported.