Commit graph

96 commits

Author SHA1 Message Date
Zeke Sikelianos
b084dc29ea move each API doc into its own file 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
21105271a4 document processes for APIs nested in parent docs 2016-11-03 11:50:00 -07:00
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Kevin Sawicki
a2a44621fd Merge pull request #7708 from tinydew4/fix-typo
Fix typo, and trimming.
2016-10-24 16:12:29 +09:00
tinydew4
67a09d9fe0 Fix typo, and trimming. 2016-10-24 06:34:09 +00:00
Kevin Sawicki
632739ec6e Merge pull request #7590 from electron/docs-cleanup
Cleanup docs and standardize structs
2016-10-24 15:13:39 +09:00
Samuel Attard
20323e7032
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00
Samuel Attard
78343a62b8
Cleanup docs and standardize structs 2016-10-13 14:38:06 +11:00
Kevin Sawicki
96e48ac13c Document cookie changed event 2016-09-29 09:16:35 -07:00
Samuel Attard
e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
deepak1556
7b85ca0301 create helper class to read blob data 2016-09-01 08:52:44 +05:30
deepak1556
be4bc6b7ef fix docs and update specs 2016-09-01 01:01:52 +05:30
deepak1556
a23e7ecf8f add docs 2016-09-01 01:01:52 +05:30
Zeke Sikelianos
7ff5649965 fix optional param spacing 2016-08-26 23:47:04 -07:00
Kevin Sawicki
1276587ebe Merge pull request #6934 from electron/add-missing-class-descriptions
Give every class a description
2016-08-23 10:16:29 -07:00
Zeke Sikelianos
098d4dc0ca improve wording about class instantiation 2016-08-22 21:45:25 -07:00
Kevin Sawicki
4fc6cf48b0 Document enableNetworkEmulation defaults 2016-08-22 14:25:42 -07:00
Zeke Sikelianos
3d371e09b7 add a blockquote for every class 2016-08-22 14:11:03 -07:00
Kevin Sawicki
e84d0ebb7e Merge pull request #6932 from electron/fix-power-save-blocker-doc-bug
Fix some invalid docs
2016-08-22 12:30:00 -07:00
Zeke Sikelianos
8c0a551d25 fix linting errors in docs 2016-08-22 11:47:55 -07:00
Haojian Wu
6a9801b82c Remove an extra space in front of #. 2016-08-12 22:01:30 +02:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
deepak1556
aa6d79a3d8 session: add proxyBypassRules option to setProxy api 2016-07-21 10:14:54 +05:30
liusi
154daa8d6a make Session::ClearStorageData's callback optional 2016-07-15 14:13:56 +08:00
Cheng Zhao
e7666b0448 docs: options of session.fromPartition 2016-07-13 12:23:14 +09:00
Kevin Sawicki
5b8c4f55e7 Update key to be httpOnly instead of session 2016-06-29 08:39:20 -07:00
Cheng Zhao
1a74177e2d docs: Separate Cookies and WebRequest classes in session.md 2016-06-22 16:34:58 +09:00
Cheng Zhao
6b1df5838c docs: ses.setUserAgent(userAgent[, acceptLanguages]) 2016-06-22 16:05:38 +09:00
Cheng Zhao
62d0dbea5a docs: Reformat the menu-item.md 2016-06-22 13:23:07 +09:00
deepak1556
4749e18fc0 fix spec and docs 2016-06-09 10:48:05 +05:30
deepak1556
ebff40b5a5 add docs 2016-06-09 10:39:18 +05:30
Cheng Zhao
3ec4fcb3ec bellow => below 2016-06-08 11:03:01 +09:00
Vadim Macagon
c2633460eb Improve documentation of ses.cookies.set()
Fix description of the `details.url` param in `ses.cookies.set()`, and clarify the fact that cookies without an expiration date will not be retained between sessions.
2016-05-25 12:46:17 +07:00
deepak1556
f68d0f324f deprecate app.allowNTLMCredentialsForAllDomains 2016-05-23 11:44:21 +05:30
Plusb Preco
4cdba29fbd 📝 Match object notation style
[ci skip]
2016-05-11 10:30:02 +09:00
Plusb Preco
f1b184ef78 📝 Fix code style issue
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco
4d7296e1db 📝 Match destructuring style
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco
5787bb0226 📝 Fix code style issue
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.

[ci skip]
2016-05-10 18:42:21 +09:00
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Zeke Sikelianos
2c8261b429 update excerpts based on feedback 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
0527b17e42 blockquote summaries 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Plusb Preco
6205dfa25f 📝 Remove additional whitespaces
[ci skip]
2016-04-22 23:30:41 +09:00
Plusb Preco
a14014941b 📝 Fix coding style issues
[ci skip]
2016-04-22 23:26:19 +09:00
Plusb Preco
66f4701d93 📝 Remove additional whitespaces
[ci skip]
2016-04-22 23:23:15 +09:00
Plusb Preco
4f4277e25e 📝 Fix coding style issues
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-04-22 22:54:43 +09:00
deepak1556
ca756c3c24 session: allow providing permission to handle external protocols 2016-04-21 05:27:07 +05:30
deepak1556
3fb39ad3ef provide option to override status line 2016-04-08 14:03:57 +05:30
Cheng Zhao
bb1e4c2208 Revert "add docs"
This reverts commit bdfc19ad20.
2016-02-24 13:25:22 +08:00