mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #4963 from preco21/document-fixes-2

Browse source 
Docs: Improve docs styles
This commit is contained in:
Kevin Sawicki 2016-03-31 15:44:31 -07:00
commit 389b2b5cdd
9 changed files with 20 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/api/app.md
View file

@ -361,16 +361,16 @@ Clears the recent documents list.
### `app.setAsDefaultProtocolClient(protocol)` _OS X_ _Windows_
* `protocol` String - The name of your protocol, without `://`. If you want your
app to handle `electron://` links, call this method with `electron` as the
parameter.
* `protocol` String - The name of your protocol, without `://`. If you want your
app to handle `electron://` links, call this method with `electron` as the
parameter.
This method sets the current executable as the default handler for a protocol
(aka URI scheme). It allows you to integrate your app deeper into the operating
system. Once registered, all links with `your-protocol://` will be openend with
the current executable. The whole link, including protocol, will be passed to
your application as a parameter.
**Note:** On OS X, you can only register protocols that have been added to
your app's `info.plist`, which can not be modified at runtime. You can however
change the file with a simple text editor or script during build time.
@ -380,11 +380,11 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
### `app.removeAsDefaultProtocolClient(protocol)` _Windows_
* `protocol` String - The name of your protocol, without `://`.
* `protocol` String - The name of your protocol, without `://`.
This method checks if the current executable as the default handler for a protocol
(aka URI scheme). If so, it will remove the app as the default handler.
**Note:** On OS X, removing the app will automatically remove the app as the
default protocol handler.

4
docs/api/auto-updater.md
View file

@ -2,7 +2,8 @@
This module provides an interface for the `Squirrel` auto-updater framework.
You can quickly launch a multi-platform release server for distributing your application by forking [electron-release-server](https://github.com/ArekSredzki/electron-release-server).
You can quickly launch a multi-platform release server for distributing your
application by forking [electron-release-server][electron-release-server].
## Platform notices
@ -101,3 +102,4 @@ should only be called after `update-downloaded` has been emitted.
[squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows
[installer]: https://github.com/atom/grunt-electron-installer
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
[electron-release-server]: https://github.com/ArekSredzki/electron-release-server

2
docs/api/ipc-renderer.md
View file

@ -69,7 +69,7 @@ hence no functions or prototype chain will be included.
The main process handles it by listening for `channel` with `ipcMain` module,
and replies by setting `event.returnValue`.
__Note:__ Sending a synchronous message will block the whole renderer process,
**Note:** Sending a synchronous message will block the whole renderer process,
unless you know what you are doing you should never use it.
### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])`

2
docs/api/tray.md
View file

@ -75,7 +75,7 @@ labeled as such.
Emitted when the tray icon is clicked.
__Note:__ The `bounds` payload is only implemented on OS X and Windows.
**Note:** The `bounds` payload is only implemented on OS X and Windows.
### Event: 'right-click' _OS X_ _Windows_