Commit graph

1916 commits

Author SHA1 Message Date
deepak1556
2044208fd6 add docs 2016-11-11 10:53:36 -08:00
Kevin Sawicki
4de2493d89 Move footer links to bottom 2016-11-11 10:22:27 -08:00
Zeke Sikelianos
ec7cae4a34 add process to contentTracing doc 2016-11-11 10:07:36 -08:00
Samuel Attard
174e51507d Update menu.md 2016-11-11 09:22:55 -08:00
Samuel Attard
494afec01d remote require could resolve to strings/numbers not just objects 2016-11-11 09:22:55 -08:00
Samuel Attard
aeefee7348 Fix the download-item doc so it correctly resembles a class 2016-11-11 09:22:55 -08:00
Samuel Attard
c1af62a3b3 Move crash-report object to it's own struct 2016-11-11 09:22:55 -08:00
Samuel Attard
11f8923c43 Fix tray and menu docs 2016-11-11 09:22:55 -08:00
Samuel Attard
63ebc41778 More docs updates 2016-11-11 09:22:55 -08:00
Samuel Attard
1a9b4b4671 First few docs made optional 2016-11-11 09:22:55 -08:00
gellert
2cf30c0d63 remove method transferred to set with null 2016-11-11 08:49:57 -08:00
gellert
16253fe708 doc fixes 2016-11-11 08:49:57 -08:00
gellert
84a3fe50dc little fix in docs 2016-11-11 08:49:57 -08:00
gellert
8ad50d1e35 adds vibrancy effect for macos 2016-11-11 08:49:57 -08:00
joshaber
999b349e94 Docit 2016-11-10 13:35:56 -05:00
Zeke Sikelianos
ef9d8fe9bd Merge pull request #7843 from electron/process-docs
document the process(es) in which APIs are available
2016-11-03 13:14:30 -07:00
Zeke Sikelianos
471b9980ec line up process annotations consistently 2016-11-03 13:13:21 -07: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
Samuel Attard
9f18a6e65c Use ES6 template strings, fix docs and remove _ERROR_ IPC event 2016-11-03 09:33:47 -07:00
Samuel Attard
857e1da6a3 Make executeJavaScript return a Promise so that caught errors can be sent to the caller 2016-11-03 09:33:47 -07:00
Zeke Sikelianos
cc18670ae1 Merge pull request #7854 from electron/fix-ipc-docs
Fix the IPC docs so the docs-linter finds the methods
2016-11-02 20:14:47 -07:00
Samuel Attard
6228ce3f35
Fix the IPC docs so the docs-linter finds the methods 2016-11-03 14:04:03 +11:00
ali.ibrahim
49cb675057 Fixing a trivial js lint issue. 2016-11-02 11:16:37 +01:00
ali.ibrahim
e8b119e636 Formatting JavaScript sample code. 2016-11-02 10:40:51 +01:00
Zeke Sikelianos
e8bb79310c document the process(es) in which APIs are available 2016-11-01 16:35:31 -07:00
tinydew4
836cd017a9 Trim: docs/api/net.md 2016-11-01 03:53:45 +00:00
Zeke Sikelianos
379c3470c8 fix formatting of new net API doc 2016-10-31 15:48:06 -07:00
Kevin Sawicki
6b2848307d Merge pull request #7807 from electron/net-docs-fixup
Quick fix up of net docs
2016-10-31 09:23:07 -07:00
Brendan Forster
651b0c0f82 fixed a couple of typos 2016-10-31 08:59:26 -07:00
Samuel Attard
4ee308fcc2 Quick fix up of net docs 2016-10-31 12:43:57 +11:00
Cheng Zhao
dfefa00a50 Merge pull request #7577 from thomsonreuters/net_module
net module
2016-10-31 10:31:56 +09:00
Kevin Sawicki
2006d64939 Merge pull request #7757 from crilleengvall/master
Adding documentation about hidden-inset
2016-10-28 02:42:57 +09:00
Kevin Sawicki
d9f3355dea Remove excess newlines 2016-10-27 10:42:31 -07:00
Kevin Sawicki
c8263a9a18 Add newlines and backticks 2016-10-27 10:41:43 -07:00
Kevin Sawicki
bb6d15ee10 Merge pull request #7750 from bheart/master
Document the fact that Accelerators are used by the globalShortcut module
2016-10-28 02:39:46 +09:00
Christian Engvall
29470dd018 Adding documentation about hidden-inset 2016-10-26 21:33:48 +02:00
tinydew4
fbe4394bbd Clean unnecessary sentences on web-contents.md 2016-10-26 15:41:47 +00:00
Will Tange
aeb774730b Link Accelerator docs to globalShortcut module
Usage of Accelerators (i.e. `globalShortcut.register`) is now documented in the Accelerator docs themselves.
2016-10-26 14:48:09 +02:00
Samuel Attard
02a7094529
Follow docs style guide for string ENUMS 2016-10-26 16:19:41 +11:00
Samuel Attard
76da80c5e9
Further clean up 2016-10-26 16:18:55 +11:00
Samuel Attard
7078ed80fa
Move webPreferences and titleBarStyle to the correct place in the docs
In their previous location `electron-docs-linter` would not output an Object structure for `webPreferences` (which is a key part of the constructor)
2016-10-26 14:31:30 +11:00
Cheng Zhao
e97d3c21a3 Merge pull request #7719 from electron/find-pasteboard
Add macOS find pasteboard support
2016-10-26 11:23:14 +09:00
Kevin Sawicki
d85c4da11b Minor formatting tweaks 2016-10-26 09:55:34 +09:00
Kevin Sawicki
d982376fc4 filename -> displayName 2016-10-26 09:47:38 +09:00
Pierre Laurac
b44371f4bf filename as Optional argument 2016-10-26 09:05:01 +09:00
Pierre Laurac
9736dc3115 Specifying macOS only method 2016-10-26 09:04:30 +09:00
Pierre Laurac
4d305b06d1 Adding documentation 2016-10-26 09:03:14 +09:00
Samuel Attard
9e425cd01e Update web-frame.md 2016-10-26 10:04:18 +11:00
ali.ibrahim
b44d5290e2 Fixing code review issues: adding a partition options and making the session option only takes Session objects. 2016-10-25 15:47:54 +02:00
ali.ibrahim
61278f9ace Fixing code review issues. 2016-10-25 12:41:01 +02:00
Kevin Sawicki
7ffc1faf5b Document read/writeFindText 2016-10-25 14:16:40 +09:00
Mike Engel
6f64ad30cb
Clarify the setMenuBarVisibility api
The setMenuBarVisibility api is only supported on Windows and Linux.
This adds some minor documentation to make that clearer. Fixes #7686
2016-10-24 22:04:45 -06:00
Kevin Sawicki
1c7d5df2fe Merge pull request #7717 from electron/doc-lists
Add newlines before lists
2016-10-25 12:40:32 +09:00
Kevin Sawicki
65e6da2673 Add newlines before lists 2016-10-25 12:38:08 +09:00
Kevin Sawicki
39a5c7dab9 Merge pull request #7631 from beakerbrowser/webview-policy-flags2
Add 'webpreferences' attribute to webview
2016-10-25 12:14:25 +09:00
Kevin Sawicki
b4cc3541a8 Minor tweaks to webpreferences docs 2016-10-25 12:08:19 +09:00
Kevin Sawicki
a2a44621fd Merge pull request #7708 from tinydew4/fix-typo
Fix typo, and trimming.
2016-10-24 16:12:29 +09:00
Cheng Zhao
ad48aeeea4 Merge pull request #7665 from beakerbrowser/privilegedschemeopts
Add options to webFrame.registerURLSchemeAsPrivileged
2016-10-24 15:56:18 +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
Kevin Sawicki
b2559d7d28 Merge pull request #7596 from electron/function-param-types
Function param types
2016-10-24 12:40:41 +09:00
ali.ibrahim
0c44d19249 net module: documenting the session property. 2016-10-20 15:48:36 +02:00
ali.ibrahim
7c17aeb6da Documenting net module: fixing linter issues. 2016-10-20 14:42:15 +02:00
ali.ibrahim
8c19d3b210 Documenting net module: various fixes. 2016-10-20 13:57:08 +02:00
ali.ibrahim
9f15191280 Formatting net documentation. 2016-10-20 12:30:03 +02:00
ali.ibrahim
69790bd7ed Documenting ClientRequest constructor options. 2016-10-20 11:58:06 +02:00
ali.ibrahim
fdfa0f4a6d Documenting the login event. 2016-10-20 11:45:45 +02:00
ali.ibrahim
7549adcfce Documenting net module: various fixes. 2016-10-19 18:31:08 +02:00
ali.ibrahim
fddbde2fd5 Documenting net module: various fixes. 2016-10-19 18:19:28 +02:00
ali.ibrahim
6e5951b764 Documenting net module: formatting. 2016-10-19 18:11:07 +02:00
ali.ibrahim
3b620b8c0c Documenting net module: various fixes. 2016-10-19 18:05:38 +02:00
ali.ibrahim
0d82fbcf37 Documenting net.IncomingMessage. 2016-10-19 16:51:44 +02:00
ali.ibrahim
5cd20a8e5d Documenting net.ClientRequest 2016-10-19 15:34:21 +02:00
ali.ibrahim
f651b21cda Fixing net doc file name. 2016-10-19 09:24:59 +02:00
Paul Frazee
0345b62369 update webFrame.registerURLSchemeAsPrivileged docs to be more specific 2016-10-18 17:13:33 -05:00
Paul Frazee
a5c62bb264 add options to webFrame.registerURLSchemeAsPrivileged 2016-10-18 15:52:41 -05:00
ali.ibrahim
9bddc2cbaa Adding net documentation skeleton. 2016-10-18 19:14:43 +02:00
Samuel Attard
9d0d1c8341
Fix bd object name 2016-10-18 15:47:18 +11:00
Dave Jeffery
00d641aaf7 Docs: Fix relative link to MAS builds tutorials
The link was 404'ing
2016-10-17 11:26:28 +01:00
Paul Frazee
194b14100e add the 'webpreferences' attribute to webviews 2016-10-14 17:16:39 -05:00
Samuel Attard
ba91bbd397
Fix spaces 2016-10-14 22:54:04 +11:00
Samuel Attard
10ef6749b3
Source -> DesktopCapturerSource 2016-10-14 13:10:37 +11:00
Samuel Attard
32c3f17f5a
Rename dcs object 2016-10-14 13:00:03 +11:00
Samuel Attard
ad45c084cc
Fix uploaddata naming 2016-10-14 11:37:36 +11:00
Kevin Sawicki
902a8c57bd Merge pull request #7602 from danburzo/cli_switches_docs
Docs: Command-line switches -- note about node.js flags, added debug flags
2016-10-13 14:13:08 -07:00
Kevin Sawicki
21cfd330c0 Switch from node man to node --help 2016-10-13 14:11:56 -07:00
Long Nhat Nguyen
c017a7a1c7 Update url (#7598)
* Update EventEmitter URL

* Update EventEmitter URL

* Enable click

* Update EventEmitter URL

* Update EventEmitter URL

* Update URL

* Update URL

* Update EventEmitter URL

* Tweak sentence and add perios
2016-10-13 14:09:14 -07:00
Dan Burzo
af17253a72 Changed link to Node docs in MD reference format 2016-10-13 13:03:29 +03:00
Dan Burzo
cfdea04c83 Added note about sending flags to Node.js, additional debug flags 2016-10-13 12:54:22 +03:00
Samuel Attard
5cf03e68d4
Fix missing type 2016-10-13 17:33:12 +11: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
tinydew4
6b39e4a210 Apply the changes about #7379 to ko_KR 2016-10-13 00:34:39 +00:00
Kevin Sawicki
fefc7c23f9 Merge pull request #7479 from bpasero/process-no-asar
Introduce ELECTRON_NO_ASAR
2016-10-12 13:48:03 -07:00
Kevin Sawicki
fcfc13c1ea Merge pull request #7579 from electron/tweak-about-panel-key-names
Use lower-case about panel option keys
2016-10-12 11:32:01 -07:00
Kevin Sawicki
1e4ef195bb Use lower-case about panel option keys 2016-10-12 11:18:21 -07:00
Kevin Sawicki
566d76def2 Mention spawning with ELECTRON_RUN_AS_NODE 2016-10-12 11:11:27 -07:00
Benjamin Pasero
656ee0d9c3 introduce ELECTRON_NO_ASAR 2016-10-12 11:11:27 -07:00
Cheng Zhao
46cd8708a4 Merge pull request #7561 from electron/windows-system-colors
Support retrieving Windows system colors
2016-10-12 15:35:18 +09:00
Zeke Sikelianos
6b7e375963 Merge pull request #7379 from electron/seperate-structs
Move reused object structures to a standard structures folder
2016-10-11 22:28:39 -07:00
Kevin Sawicki
c8189046fe Emit color-changed event on Windows 2016-10-11 13:15:27 -07:00
Kevin Sawicki
2656812dea Doc systemPreferences.getColor 2016-10-11 13:15:27 -07:00
Kevin Sawicki
39aa740c88 Merge pull request #7552 from electron/fix-menu-docs
fix Menu API example
2016-10-11 09:47:30 -07:00
Cheng Zhao
4ae190dab9 Merge pull request #7549 from electron/about-panel-options
Support setting about panel options
2016-10-11 20:18:23 +09:00
Zeke Sikelianos
619f74fa12 fix Menu example 2016-10-10 23:01:35 -07:00
Kevin Sawicki
58ef0bea17 Doc app.setAboutPanelOptions 2016-10-10 13:40:57 -07:00
Kevin Sawicki
25bcc2dd0d 🎨 2016-10-10 10:43:09 -07:00
Kevin Sawicki
af27c62b07 Doc inverted-color-scheme-changed event 2016-10-10 10:43:08 -07:00
Kevin Sawicki
223e9d97a0 Doc systemPreferences.isInvertedColorScheme 2016-10-10 10:43:08 -07:00
tinydew4
9f42c4c441 Fix dot 2016-10-10 14:31:05 +00:00
Cheng Zhao
91591f37e6 Merge pull request #7500 from electron/store-crashes-in-configured-temp-dir
Store crash reports in configured temp dir
2016-10-10 10:19:02 +09:00
Zeke Sikelianos
2acd7f4d12 fix NativeImage link path 2016-10-07 21:25:39 -07:00
Samuel Attard
4d49156dac
Rename bounds -> rectangle 2016-10-08 13:09:31 +11:00
Zeke Sikelianos
f80e81bf9f standardize 2016-10-06 12:20:00 -07:00
Samuel Attard
2b05c61ae3 Update docs for parsing 2016-10-06 12:19:38 -07:00
Samuel Attard
b859afc118 Update docs to follow the 'link first instance' standard 2016-10-06 12:19:38 -07:00
Samuel Attard
03979936f3 Move reused object structures to a standard structures folder 2016-10-06 11:59:42 -07:00
Kevin Sawicki
e38fc724f8 Merge pull request #7508 from miniak/docs-fix
Add missing documentation
2016-10-06 11:11:31 -07:00
Kevin Sawicki
451cea4675 Add newline before list 2016-10-06 11:02:30 -07:00
Zeke Sikelianos
2cda2bd718 Merge pull request #7502 from squarejaw/patch-1
Fix misspelling in docs/api/app.md
2016-10-06 10:44:11 -07:00
Kevin Sawicki
eafc694bba Mention crash report locations 2016-10-06 09:02:01 -07:00
Milan Burda
cb15181f43 Fix typo 2016-10-06 12:03:37 +02:00
Milan Burda
9f342ebbd1 Add missing documentation 2016-10-06 11:30:34 +02:00
Cheng Zhao
10b91b1291 Merge pull request #7488 from electron/native-image-resize-and-crop
Support resizing and cropping native images
2016-10-06 15:01:41 +09:00
Cheng Zhao
5285b729be Merge pull request #7407 from thomsonreuters/New_Window_Handler_Can_Create_And_Return_Window
New-window event handler can return its own BrowserWindow instance
2016-10-06 14:37:48 +09:00
Bryan Bess
9bc6000cb5 📝 Fix misspelling in docs/api/app.md [ci skip] 2016-10-05 19:17:49 -05:00
Kevin Sawicki
4b95f3a462 Mark width/height as optional 2016-10-05 11:02:58 -07:00
Kevin Sawicki
abffd98e29 Resize images with preserve aspect ratio 2016-10-05 11:02:58 -07:00
Kevin Sawicki
56f9cc683a bounds -> rect 2016-10-05 11:02:57 -07:00
Kevin Sawicki
9fa13710aa Document crop and resize 2016-10-05 11:02:57 -07:00
Kevin Sawicki
5e936a24ac Add newline before list 2016-10-05 09:24:33 -07:00
Michael Vasseur
22bd7c0271 Updated the related documentation 2016-10-05 09:47:38 +02:00
Dave Jeffery
29b9fbcc9a Docs: Move buffer link to end of file 2016-10-04 21:34:24 +01:00
Dave Jeffery
4d10b9a31b Docs: Correct image.getSize() type signature 2016-10-04 21:20:42 +01:00
Cheng Zhao
c4576463e2 Format the docs according to style guide 2016-10-04 14:41:37 +09:00
Michael Vasseur
3af686daff Documented JavasScript API changes related to the fix for additional features processing 2016-10-04 14:38:32 +09:00
Joseph Frazier
5d1c626a53 Fix webContents.findInPage links in docs 2016-10-03 02:07:52 -04:00
Kevin Sawicki
96e48ac13c Document cookie changed event 2016-09-29 09:16:35 -07:00
Cheng Zhao
e1d68fa3cd Merge pull request #7374 from electron/fixup-return-values
Update docs to contain more specific return values
2016-09-29 16:44:08 +08:00
Kevin Sawicki
241297fb2e Merge pull request #7388 from electron/custom-window-level-test
Add test for BrowserWindow.setAlwaysOnTop
2016-09-28 15:47:29 -07:00
Kiavash Page
d42e51e33a app.md - fix relaunch arg concat syntax 2016-09-28 10:23:03 -07:00
Kevin Sawicki
fd6ef6712f Link to window level macOS docs 2016-09-28 09:20:22 -07:00
Cheng Zhao
53d4c36332 Merge pull request #7353 from electron/no-login-item-apis-on-mas
document lack of MAS support for login item APIs
2016-09-28 19:20:32 +08:00
Cheng Zhao
de76bf5f63 Merge pull request #7296 from adammeyer/custom-window-level
Allow custom window level when sending window to top
2016-09-28 19:18:12 +08:00
Samuel Attard
e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Zeke Sikelianos
6728efe87e Merge pull request #7339 from electron/document-return-values
Document the return values of all methods in the docs
2016-09-27 07:39:25 -07:00
Cheng Zhao
7e1ae369ed Merge pull request #7356 from electron/fix-typo
fix typo
2016-09-27 19:05:06 +08:00
Cheng Zhao
4c8d0ab804 Merge pull request #7298 from deepak1556/content_settings_patch
protocol: disable storage for non standard custom schemes
2016-09-27 18:52:36 +08:00
Zeke Sikelianos
1f677ed361 fix typo 2016-09-26 22:12:51 -07:00