Samuel Attard
f80601da16
docs: ensure that optionality matches between documented params and signatures ( #18613 )
...
* docs: ensure that optionality matches between documented params and signatures
* docs: ensure that all optional declarations are lower case
* chore: fix broken link
2019-06-04 14:03:24 -07:00
Jeremy Apthorp
c436997840
feat: add ipcRenderer.invoke() ( #18449 )
2019-05-31 10:25:19 -07:00
Samuel Attard
a96b6e2c96
build: move to the new docs parser ( #18103 )
...
* build: move to the new docs parser
* chore: remove the bad getTitle param doc
* build: update parser/ts gen deps + fix some docs issues highlighted by GH desktop
* chore: apply suggestions from code review
Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
* chore: update docs for accidentally removed things
* chore: update docs/api/command-line.md
Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
2019-05-06 08:29:01 -07:00
Samuel Attard
3b74837020
refactor: Split 'Event' docs/types into more specific Event types ( #17038 )
...
* Event = Base event type (with preventDefault)
* IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.)
* IpcRendererEvent = Event that ipcRenderer emits (with sender,
senderId, etc.)
* KeyboardEvent = Event that we emit with keyboard flags (ctrlKey,
altKey, etc.)
This will dramatically improve peoples TS experience with IPC events
2019-02-19 09:24:19 +00:00
Shelley Vohr
7a03e5f0b2
doc: correct ipcRenderer sendTo windowId param ( #15403 )
2018-10-26 10:18:47 -05:00
Milan Burda
c17a1b37ea
feat: add event.senderId property to IPCs sent via ipcRenderer.sendTo ( #14395 )
2018-08-31 20:13:51 -05:00
Toinane
3d4ef66775
add some markdown links
2017-11-29 12:13:45 +01:00
Toinane
0a0d88a5dc
remove all double spaces not needed
2017-11-29 11:58:24 +01:00
Toinane
323ea2b27b
fix(docs): fix all missing dots and add some links
2017-11-29 11:38:35 +01:00
73mp74710n
0a0897ef28
Update ipc-renderer.md
2017-10-18 02:52:02 +01:00
73mp74710n
c647b0c65e
update docs to show usage of ipcRenderer.sendTo
2017-10-18 02:35:19 +01:00
Samuel Attard
e58ba1dc8e
Update ipc-renderer.md
2017-08-29 16:12:55 +10:00
Zeke Sikelianos
f646be2981
document the return value of ipcRenderer.sendSync
2017-06-27 12:01:39 -07:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -08:00
Samuel Attard
63ebc41778
More docs updates
2016-11-11 09:22:55 -08: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
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
Samuel Attard
6228ce3f35
Fix the IPC docs so the docs-linter finds the methods
2016-11-03 14:04:03 +11: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
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
546ad643e4
📝 Add missing docs
...
[ci skip]
2016-03-31 14:30:14 +09:00
Cheng Zhao
b8e8e4c930
docs: Cleanup the IPC docs
2016-02-16 11:34:39 +08:00
Luke Page
2c6e5d0464
Clarify arguments sent via ipc
2016-02-15 06:29:52 +01:00
Mark Potnick
b9e2806042
Fixing typo
2016-02-03 15:15:13 -05:00
Ming Luo
ad9c254730
Styled the removeListener & removeAllListeners
...
They were previously not written with the same style as other parts of
the doc. Also there was a couple grammar errors
2016-01-14 09:27:24 -05:00
Ming Luo
a82ecfda06
Detail ipc.removeListener & ipc.removeAllListeners
2016-01-13 10:18:12 -05:00
Eran Tiktin
b7ae9d3337
Update ipc-renderer.md
...
Removed duplication.
2015-11-19 02:11:32 +02:00
Cheng Zhao
90a7d4a906
docs: Update with new IPC modules
2015-11-10 16:48:24 +08:00
Jessica Lord
279fd0a461
Standardize **Note:**
2015-09-09 14:09:14 -07:00
Jessica Lord
8ee91bce44
message → arg
2015-08-28 14:57:14 -07:00
Jessica Lord
dbc1855b42
Small edits
2015-08-28 14:21:37 -07:00
Jessica Lord
d02ced87b8
message → arg, 80-col
2015-08-27 10:13:25 -07:00
Jessica Lord
a1f17069ec
First run t ipc-r
2015-08-26 17:56:10 -07:00
Joseph Dykstra
b6875ad49b
Renamed browser-side to main process
...
renamed a few occurances of "web page" to "renderer"
renamed a few files that had "browser" in their name to "main-process"
note that there are still many occurances of web page.
2015-03-26 10:20:31 -05:00
Cheng Zhao
a8f5a4e2d4
Add sendToHost method
2014-12-17 11:09:11 -08:00
Cheng Zhao
5933947000
📝 Simpilify the structure of API references.
2014-05-05 14:24:57 +08:00
