Commit graph

2166 commits

Author SHA1 Message Date
Cheng Zhao
9eacd07eda Merge pull request #6489 from electron/webcontents-static-api
Document static methods on webContents
2016-07-15 11:02:00 +09:00
Cheng Zhao
52808d5342 Merge pull request #6499 from electron/drop-vista
Remove implicit references to Vista in docs
2016-07-15 10:20:14 +09:00
Cheng Zhao
d186a01815 Merge pull request #6497 from electron/windows-thumbnail
Add setThumbnailClip API on Windows
2016-07-15 10:18:39 +09:00
Cheng Zhao
5db758297f Merge pull request #6486 from MarshallOfSound/master
Add a getFeedURL API for the autoUpdater
2016-07-15 10:02:05 +09:00
Kevin Sawicki
297365b4f0 Add require example for webContents 2016-07-14 17:54:18 -07:00
Kevin Sawicki
4de4774325 Update headings/sections to follow docs styleguide 2016-07-14 17:46:58 -07:00
Cheng Zhao
7c56169633 Merge pull request #6495 from electron/link-to-boilerplates
link to boilerplates
2016-07-15 09:44:29 +09:00
Cheng Zhao
c3ed4b5527 Merge pull request #6493 from electron/elecron-devtools-installer
mention electron-devtools-installer as an alternative
2016-07-15 09:44:01 +09:00
Kevin Sawicki
1aa645522a Remove implicit references to Vista 2016-07-14 17:33:48 -07:00
Cheng Zhao
16e43a7f15 Merge pull request #6490 from wilsonpage/add-drop-text-support
Add support for dropped text in osx
2016-07-15 09:12:35 +09:00
Cheng Zhao
3ace677b41 Merge pull request #6474 from darkdh/cert_detail
Add more detail attributes for certificate-error
2016-07-15 08:45:36 +09:00
Zeke Sikelianos
7700c5e249 denote return type on process memory info methods methods 2016-07-14 16:10:19 -07:00
Zeke Sikelianos
595b827a13 Use common style to denote OS-specific arguments 2016-07-14 16:09:29 -07:00
Kevin Sawicki
f4a160d0fb Add properties as sub-list 2016-07-14 16:02:06 -07:00
Kevin Sawicki
ccee3e1fc2 Document setThumbnailClip 2016-07-14 15:54:57 -07:00
Zeke Sikelianos
ee677ea212 link to boilerplates 2016-07-14 14:57:06 -07:00
Zeke Sikelianos
52a2ed9205 fix typo 2016-07-14 14:16:02 -07:00
Zeke Sikelianos
f857be431a mention electron-devtools-installer as an automated alternative 2016-07-14 14:12:06 -07:00
Wilson Page
90f8a7e828 Add support for dropped text in osx 2016-07-14 18:25:58 +01:00
Kevin Sawicki
c680c0b85e Document static webContents methods 2016-07-14 09:00:29 -07:00
Samuel Attard
b367c65bcd Add docs for getFeedURL 2016-07-15 00:07:17 +12:00
Cheng Zhao
21a2feaf23 Merge pull request #6480 from electron/webcontents-focus
Execute role-based menu items on focused web contents
2016-07-14 12:47:07 +09:00
Cheng Zhao
183b599b9c Merge pull request #6470 from electron/session-options
Ad options for creating Session
2016-07-14 12:07:39 +09:00
Kevin Sawicki
e1459b7db7 Doc webContents.isFocused 2016-07-13 14:20:33 -07:00
Anthony Tseng
db39867ad9 Add more detail attributes for certificate-error 2016-07-13 22:14:47 +08:00
Zeke Sikelianos
9b1d1dc2c7 clarify rules for documenting classes 2016-07-12 22:00:28 -07:00
Zeke Sikelianos
4905d30dd6 fix heading levels on BrowserWindowProxy 2016-07-12 21:57:07 -07:00
Zeke Sikelianos
5ab4fd261c 🎨 2016-07-12 21:50:43 -07:00
Zeke Sikelianos
b20606c718 fix heading levels in Menu doc 2016-07-12 21:47:28 -07:00
Zeke Sikelianos
2486512c71 use h3/h4 for instance headings and children 2016-07-12 21:42:08 -07:00
Zeke Sikelianos
f8045fd743 💄 2016-07-12 21:40:46 -07:00
Zeke Sikelianos
6d8a6e6471 use consistent wording for instances 2016-07-12 21:30:27 -07:00
Zeke Sikelianos
a304a59d36 use h3/h4 for static method headings and methods 2016-07-12 21:29:09 -07:00
Zeke Sikelianos
fff036b6ab distinguish static methods from module methods 2016-07-12 21:28:27 -07:00
Zeke Sikelianos
a08ee97fb0 use h3/h4 for instance events headings and events 2016-07-12 21:24:22 -07:00
Zeke Sikelianos
67dbff1d4a events -> instance events 2016-07-12 21:22:54 -07:00
Zeke Sikelianos
e866c68938 📝 minor style changes and typos 2016-07-12 21:21:25 -07:00
Cheng Zhao
e7666b0448 docs: options of session.fromPartition 2016-07-13 12:23:14 +09:00
Plusb Preco
9ea4039887 📝 Fix grammatical typo
[ci skip]
2016-07-13 03:02:14 +09:00
Plusb Preco
039aebb74a 📝 Fix isolated link
[ci skip]
2016-07-13 02:59:29 +09:00
Plusb Preco
19765e70cf 📝 Fix typo
[ci skip]
2016-07-13 02:57:11 +09:00
Kevin Sawicki
66d16b2871 Add Windows label to login items settings API 2016-07-12 09:10:48 -07:00
Cheng Zhao
3eaa32fc87 Merge pull request #6447 from ellerbrock/broken-link-fix
fix broken link
2016-07-12 11:01:52 +09:00
Cheng Zhao
df0d2b89cd Merge pull request #6446 from electron/accessibility-api
Add API for Chrome's accessibility support state
2016-07-12 10:59:12 +09:00
Maik Ellerbrock
01cb024f44 fix broken link
fixed broken link "how to share data between web pages" in section "Differences Between Main Process and Renderer Process"
2016-07-12 07:31:18 +08:00
Kevin Sawicki
46a1e0382d Document accessibility support API 2016-07-11 14:41:35 -07:00
Robert D
2d40ced3be Fix link to locales.md 2016-07-11 11:37:22 -07:00
Vladimir Krivosheev
d824e3a959 docs: electron-userland package tools links
`electron-packager` and `electron-builder` now in the `electron-userland` github org — links fixed.
2016-07-11 13:05:02 +02:00
Cheng Zhao
26fe38a296 docs: showHiddenFiles 2016-07-11 13:52:44 +09:00
Cheng Zhao
e8e2763131 win: Add toolbar type for BrowserWindow 2016-07-11 12:46:50 +09:00
vsemozhetbyt
4f62050b01 Fix typo in the web-contents.md
📝 `false` -> `true` in the `webContents.print` `silent` explanation.

[ci skip]
2016-07-09 20:31:02 +03:00
mihaipocorschi
a3388b1d25 Fixed broken FAQ link in docs/README.md 2016-07-09 16:14:42 +03:00
Cheng Zhao
b70090170d docs: thickFrame option 2016-07-09 21:52:45 +09:00
Kevin Sawicki
d02a453c51 Merge pull request #6391 from electron/getlocale-oneline
New title and one-liner for app.getLocale() doc
2016-07-08 12:45:41 -07:00
vsemozhetbyt
1726327bfa Fix typo in the web-view-tag.md
📝 Remove a redundant # from a href hash.

web-contents.md##webcontentssendinputeventevent ->
web-contents.md#webcontentssendinputeventevent

[ci skip]
2016-07-08 22:15:51 +03:00
Jessica Lord
e25001e277 Rename file 2016-07-08 09:43:48 -07:00
Cheng Zhao
5713e0599b Merge pull request #6375 from electron/login-item
Add login item API
2016-07-08 10:39:20 +09:00
vsemozhetbyt
ba9baec27f Fix typos in the remote.md
📝 Fixes #6387

[ci skip]
2016-07-08 04:00:22 +03:00
Cheng Zhao
b02a83c96e Merge pull request #6390 from vsemozhetbyt/patch-1
One alphabetical reordering in the docs/README.md
2016-07-08 09:52:32 +09:00
Jessica Lord
ea64db9e5c More concise wording 2016-07-07 17:45:35 -07:00
vsemozhetbyt
9c5d36f0c6 One alphabetical reordering in the docs/README.md
📝 webContents, Tray -> Tray, webContents

If I get it right, only API TOCs should be ordered alphabetically,
so I've left other ones (Guides, Tutorials, Development) untouched.
I'm not so sure about API TOC Intro (three links below the "Synopsis"),
tell me if they should be sorted alphabetically too.

[ci skip]
2016-07-08 03:33:22 +03:00
Jessica Lord
ae8b78aff8 New title and one-liner 2016-07-07 17:33:06 -07:00
Kevin Sawicki
cde594775d Remove API that is no longer available 2016-07-07 16:41:08 -07:00
Kevin Sawicki
10bb8df09a Update login item API docs 2016-07-07 16:33:26 -07:00
Jessica Lord
00fab4688b Move and rename FAQ 2016-07-07 10:13:19 -07:00
vsemozhetbyt
34ed2c4da4 Fix a hash of a link href in the remote.md
📝 web-contents.md#webcontentsexecutejavascriptcode-usergesture ->
web-contents.md#webcontentsexecutejavascriptcode-usergesture-callback
2016-07-07 18:52:49 +03:00
Gabriel Augendre
72e811fea4 Highlight the whole eval() override
I updated the link to hightlight not only the first line but the whole `window.eval()` override.
2016-07-07 12:22:12 +02:00
Cheng Zhao
c70635daff docs: Some dlls are not there anymore 2016-07-07 10:17:49 +09:00
Kevin Sawicki
49b32b8380 Mention open as hidden is manually configurable 2016-07-06 14:17:19 -07:00
Kevin Sawicki
667b6d6370 Doc login item APIs 2016-07-06 14:10:25 -07:00
Kevin Sawicki
c2ecc49be2 Defer to webContents docs 2016-07-06 09:21:29 -07:00
Kevin Sawicki
ce4ef1ccb8 Update capturePage documentation for new location 2016-07-06 09:21:28 -07:00
vsemozhetbyt
c2bf6c2460 Fix disordered definitions in webContents doc
📝 Swap `clearSelection` and `keepSelection` definitions
for `webContents.stopFindInPage(action)` that seems to be in wrong order.

[ci skip]
2016-07-06 18:58:50 +03:00
Jonathan Sampson
7baf7372af modern.ie is no longer in use
The URL exists for historical reasons, but is no longer the primary URL for developer resources.
2016-07-05 19:34:33 -07:00
Cheng Zhao
8d3e09747a directWrite option is removed 2016-07-05 09:20:57 +09:00
Cheng Zhao
ba1fe322e9 docs: Use <a> as example 2016-07-03 15:27:26 +09:00
Cheng Zhao
b7459d50f9 docs: Dragging files out of the window 2016-07-03 15:26:22 +09:00
Cheng Zhao
f072d9dd3a docs: webContents.startDrag(item) 2016-07-03 15:10:59 +09:00
Cheng Zhao
74ebbf9c78 docs: Add trailing period 2016-07-02 20:27:14 +09:00
Samuel Attard
7f914c65de Update docs to match style guide 2016-07-02 23:21:45 +12:00
Samuel Attard
bbaab9b355 Document possible getLocale returns values. Closes #5363 2016-07-02 21:17:37 +12:00
Kevin Sawicki
b47d0e3e58 Tweak launcher note text 2016-07-01 08:51:25 -07:00
Cheng Zhao
1da2a1c2ae app.setBadgeCount should return boolean 2016-07-01 22:20:05 +09:00
Cheng Zhao
f8ec377123 docs: app.setBadgeCount 2016-07-01 17:44:09 +09:00
Cheng Zhao
36a0a491c9 Merge pull request #6216 from electron/class-docs
Add details to docs/styleguide.md
2016-07-01 05:34:01 +00:00
Cheng Zhao
3965440952 conjunctions don't have to be capitalized 2016-07-01 14:33:22 +09:00
Cheng Zhao
1626c3bf0a Use * instead of - for lists
`*` is used in most lists in our docs, let's keep consistency.
2016-07-01 14:30:55 +09:00
Cheng Zhao
83e9521d13 Update atom-shell-vs-node-webkit.md 2016-07-01 14:27:56 +09:00
Jonas Schwabe
768ff7af5a Add additional method isUnityRunning, fix multiple typos in docs 2016-06-29 20:22:17 +02:00
Jonas Schwabe
e2d389fbd4 Rename the unityLauncher api to launcher and make it available on linux in general. + Document it only works on ubuntu 2016-06-29 20:22:17 +02:00
Jonas Schwabe
336a55cb23 📝 docs for unity launcher badge api 2016-06-29 20:22:17 +02:00
Kevin Sawicki
5b8c4f55e7 Update key to be httpOnly instead of session 2016-06-29 08:39:20 -07:00
Cheng Zhao
e1ad64013e Cleanup code of beginFrameSubscription 2016-06-26 11:46:40 +09:00
Cheng Zhao
3d2ad0080d Merge pull request #6164 from MaxWhere/master
beginFrameSubscription bugfix and improvement
2016-06-26 02:39:59 +00:00
Heilig Benedek
5118def724 damaged -> dirty rename, fixed misc issues, changed signature, updated docs and added tests 2016-06-25 18:23:40 +02:00
Kevin Sawicki
f90ef12814 read/writeBookmark is not implemented on Linux 2016-06-24 17:16:38 -07:00
Zeke Sikelianos
aee111bf2f minor wording changes and tweaks 2016-06-24 15:59:30 -07:00
Kevin Sawicki
9479536bb8 Tweak return value description 2016-06-24 15:35:30 -07:00
Kevin Sawicki
6588b85ac9 Mention empty strings 2016-06-24 15:31:15 -07:00
Kevin Sawicki
30a628b46f Remove unsupported type 2016-06-24 15:29:39 -07:00
Kevin Sawicki
a2ba778adc Document clipboard bookmark support 2016-06-24 15:20:49 -07:00
Kevin Sawicki
9fab641ecb Add missing rtf key 2016-06-24 15:17:31 -07:00
Kevin Sawicki
63e2ee8e10 Add link to Boolean 2016-06-24 12:45:22 -07:00
Kevin Sawicki
47504c5a53 Use more lists 2016-06-24 12:40:55 -07:00
Kevin Sawicki
5dd7bf67e7 Minor formatting and wording tweaks 2016-06-24 12:28:41 -07:00
Sudar Abisheck
0e1caa5961 Update quick-start.md
Corrected the anchor text
2016-06-24 11:29:55 +05:30
Cheng Zhao
38592aaef7 Add details to docs/styleguide.md 2016-06-24 10:45:37 +09:00
Cheng Zhao
eb55fba9f4 Merge pull request #6211 from electron/debugging-main-process-docs
Update debugging main process docs
2016-06-24 00:25:26 +00:00
Cheng Zhao
fa023842d3 Merge pull request #6111 from electron/docs-formatting
Docs formatting
2016-06-24 00:24:57 +00:00
Kevin Sawicki
adc8c54a81 Minor formatting updates 2016-06-23 14:23:34 -07:00
Kevin Sawicki
eb8c1b1a50 Make update number message a note 2016-06-23 14:20:52 -07:00
Kevin Sawicki
5e389021eb Use upstream node-pre-gyp 2016-06-23 14:19:23 -07:00
Zeke Sikelianos
3dcbbe9f20 remove parens from type 2016-06-23 14:13:03 -07:00
Zeke Sikelianos
cfebf7aa6b fix list indentation 2016-06-23 10:36:16 -07:00
Cheng Zhao
e70c622a70 Merge pull request #6190 from electron/default-label-and-accelerator
Add default label and accelerator for menu item roles
2016-06-23 05:34:10 +00:00
Cheng Zhao
6cfd078d19 Merge pull request #6174 from electron/session-docs-cleanup
docs: Separate Cookies and WebRequest classes in session.md
2016-06-23 04:05:18 +00:00
Kevin Sawicki
e9222583cb toPng/toJpeg -> toPNG/toJPEG 2016-06-22 15:47:42 -07:00
Kevin Sawicki
4dbdcad05e Remove label/accelerators with role defaults 2016-06-22 14:37:16 -07:00
Kevin Sawicki
c98f419bc8 Doc role defaults 2016-06-22 14:10:44 -07:00
Milan Burda
c243cf0c0f Add BrowserWindow.prototype.setContentProtection(enable) 2016-06-22 10:40:33 +02: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
Zeke Sikelianos
271c39ceb3 OS X → macOS 2016-06-21 23:02:01 -07:00
Zeke Sikelianos
72403c1a8d use consistent verb style 2016-06-21 22:56:51 -07:00
Zeke Sikelianos
90d1b9169f prepositions are hard 2016-06-21 22:55:26 -07:00
Zeke Sikelianos
2a079b2e0a wether → whether 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
0ff50650d2 document drop-files event type 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
574e8974b6 undo heading changes to special-case session 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
a82a2485d7 fix debugger event headings 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
49fd3ff41b document platform-specific arguments 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
74e0535659 use unformatted raw code examples in styleguide 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
0d481aaeb8 📝 use h3 headings for events and methods, per the styleguide 2016-06-21 22:54:43 -07:00
Cheng Zhao
62d0dbea5a docs: Reformat the menu-item.md 2016-06-22 13:23:07 +09:00
Cheng Zhao
8d08e215b2 Add "event" parameter for "click" handler of MenuItem 2016-06-22 11:22:14 +09:00
Kevin Sawicki
35097b244e Doc togglefullscreen menu item role 2016-06-21 09:43:29 -07:00
Kevin Sawicki
395c372702 Document quit role 2016-06-21 09:08:13 -07:00
Heilig Benedek
712141f153 Updated docs for beginFrameSubscription 2016-06-21 13:35:30 +02:00
Cheng Zhao
9d63199c37 docs: Make tray.md follow docs style guide 2016-06-21 16:20:33 +09:00
Cheng Zhao
11f242a241 docs: Tray.getBounds() 2016-06-21 16:13:50 +09:00
Charlie Hess
74321dce74 Add systemPreferences.subscribeLocalNotification. (#6150) 2016-06-21 00:48:42 +00:00
Cheng Zhao
f7a9b1ae04 docs: modal window is greatly simplified 2016-06-20 16:00:38 +09:00
Cheng Zhao
946d246aea docs: Parent and child windows 2016-06-20 11:21:34 +09:00
Cheng Zhao
c44a6ad8b8 Merge pull request #6135 from blainesch/patch-1
Add copy/pasta example for system preferences.
2016-06-20 00:34:40 +00:00
Samuel Attard
ea38916c27 Fix typo in DevTools Extensions tutorial 2016-06-20 02:24:00 +10:00
Blaine Schmeisser
c75f3a8b5e Add copy/pasta example for system preferences.
Most of the other api docs have one example of where to find the module in a copy/paste format. This pull request adds one for the system preferences.
2016-06-19 08:53:34 -07:00
Leonard Lamprecht
511bf83fe7 Improved wording 2016-06-18 15:28:22 +02:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Kevin Sawicki
6709e3c338 Mark which APIs are unavailable before app ready 2016-06-17 15:06:59 -07:00
Mark Judd
bf6133d61f 📝 Fix minor text issues. 2016-06-17 11:45:12 -04:00
Cheng Zhao
1a70fd8efe Merge pull request #6087 from electron/public-app-menu-getter
Make Menu.getApplicationMenu() public
2016-06-17 00:40:14 +00:00