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

document platform-specific arguments

Browse source
This commit is contained in:
Zeke Sikelianos 2016-06-17 12:33:50 -07:00
parent 74e0535659
commit 49fd3ff41b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/styleguide.md
View file

@ -70,6 +70,14 @@ of argument is notated by either the common types:
[`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
or a custom type like Electron's [`webContent`](api/web-content.md).
If an argument is unique to certain platforms, those platforms are denoted
using a space-delimited italicized list following the datatype. Values can be
`OS X`, `Windows`, or `Linux`.
```
* `animate` Boolean (optional) _OS X_ _Windows_
```
### Events
An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event)