Commit graph

26 commits

Author SHA1 Message Date
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07: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
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06: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
Zeke Sikelianos
b92e86301a use cross-platform accelerator in globalShorcut documentation 2016-04-01 14:54:25 -07:00
Cheng Zhao
9e254821bb docs: Mention the limitation of globalShortcut
Close #3816.
2016-01-07 21:28:14 +08:00
Stephen Niedzielski
0b245b96e4 Update docs for globalShortcut.register
Document return value for globalShortcut.register and common failure scenario.

Fix: #3600
2015-11-26 22:38:47 -07:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Steve Kinney
2978beaeb7 💄 Add preposition to globalShortcut.unregisterAll() 2015-10-07 09:03:46 -07:00
Steve Kinney
6f61832a34 💄 Add semicolon to global-shortcut code example
This keeps this line consistent with the rest of the documentation.
2015-10-07 09:03:11 -07:00
Jessica Lord
279fd0a461 Standardize **Note:** 2015-09-09 14:09:14 -07:00
Jessica Lord
dbc1855b42 Small edits 2015-08-28 14:21:37 -07:00
Jessica Lord
a34a16653e Standardize global-shortcut 2015-08-26 17:32:47 -07:00
Jeffrey Morgan
ce24226128 Update global-shortcut.md
Improved the grammar and code formatting of global-shortcut.md.
2015-07-14 16:58:15 +01:00
Hank Bao
fc9612a5ed Fix sample code indention 2015-07-09 22:49:16 +08:00
Hank Bao
fb99bfac52 Update sample code in global-shortcut.md 2015-07-09 17:03:58 +08:00
Hank Bao
7b19b6b4f2 Update global-shortcut.md
Make it clear that the `global-shortcut` module should not be used until the ready event of app module gets emitted.
2015-07-09 12:30:37 +08:00
Thomas Tuts
e829a28947 Clean up code in global shortcut code example 2015-06-09 18:01:09 +02:00
Thomas Tuts
13b6ed6dc5 Fix several typos and grammar errors 2015-06-09 16:49:21 +02:00
Sam Saccone
161dc45ec8 📝 Fix english errors and clarify docs 2015-06-06 21:46:51 -04:00
Cheng Zhao
6dc01945af Make Accelerator a standalone JS type.
This makes menu and global-shortcut share the same code on accelerator.
2014-08-05 00:03:58 +08:00
Haojian Wu
681de1b048 📝 Update global-shortcut API document. 2014-08-04 10:11:00 +08:00