Commit graph

63 commits

Author SHA1 Message Date
Kevin Sawicki
6d5fbe6be2 Document scale factor option 2017-03-07 12:27:55 -08:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
98d4e186e3 Move details next to params 2016-12-14 10:19:38 -08:00
Kevin Sawicki
3b259b4243 Add createFromBuffer to planned breaking changes 2016-12-14 10:12:37 -08:00
gellert
7ceb8d1ab8 additional tests for createFromBuffer 2016-12-14 00:18:24 +01:00
gellert
a609e52a14 moves bitmap parameters to options object 2016-12-13 21:32:17 +01:00
gellert
39875c90f1 adds bitmap support to createFromBuffer 2016-12-13 21:32:17 +01:00
Zeke Sikelianos
4770d2b526 returns an instance, not the module 2016-11-16 09:02:49 -08: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
Kevin Sawicki
451cea4675 Add newline before list 2016-10-06 11:02:30 -07: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
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
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Kevin Sawicki
546c0e7822 Mention createFromPath failure cases 2016-09-21 10:48:01 -07:00
Zeke Sikelianos
3d371e09b7 add a blockquote for every class 2016-08-22 14:11:03 -07:00
Cheng Zhao
1be253e1aa Cleanup the code of getBitmap 2016-08-05 18:05:44 +09:00
Heilig Benedek
b5c19a9c6d update docs 2016-08-05 17:40:42 +09:00
Milan Burda
e7322edb3a docs: Improve ICO size list 2016-08-01 13:13:40 +02:00
Heilig Benedek
2b05be64b4 add documentation for changes 2016-08-01 02:14:45 +02:00
Yuya Ochiai
29d66eb0d0 📝 Add recommended sizes for Windows ICO icons
For #6396
Please refer to https://msdn.microsoft.com/en-us/library/windows/desktop/dn742485(v=vs.85).aspx
[ci skip]
2016-07-28 23:22:41 +09:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Zeke Sikelianos
9432cb9170 use standard-style javascript in nativeImage doc 2016-07-22 13:47:05 -07:00
Zeke Sikelianos
9ca0fbaeb7 fix capitalization and headings for NativeImage class 2016-07-22 13:42:27 -07:00
Kevin Sawicki
e9222583cb toPng/toJpeg -> toPNG/toJPEG 2016-06-22 15:47:42 -07:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Vadim Macagon
8e2ae9b9e7 Fix location of code snippet in nativeImage docs
The code snippet for `nativeImage.createFromPath` somehow ended up in the wrong section of the document, this PR moves it back where it belongs.
2016-06-08 23:34:45 +07:00
Cheng Zhao
5a9eb5cfa6 Choose the correct icon size for Windows taskbar 2016-05-30 09:46:42 +09:00
Cheng Zhao
b33c04d041 docs: Recommend to use ICO icon 2016-05-20 19:58:47 +09:00
Plusb Preco
885aeec442 📝 Match variable names
[ci skip]
2016-05-11 02:16:32 +09: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
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
Cheng Zhao
f8b9a66ead docs: Make it clear image.getNativeHandle is OS X only 2016-03-17 21:55:44 +09:00
Paul Betts
f59752bf4f Update the docs to match 2016-03-14 19:51:37 -07:00
Paul Betts
5dea4b9b1c Add documentation 2016-03-13 20:11:43 -07:00
Cheng Zhao
4ad79b2a8c docs: Standarize the "(**required**)" 2015-12-18 11:12:48 +08:00
Cheng Zhao
fbb8e61958 Replace "Url" in API names with "URL" 2015-11-13 16:03:40 +08:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Eran Tiktin
c3cd438d34 Replace io.js references with node.js references 2015-10-05 21:12:29 +03:00
Jessica Lord
279fd0a461 Standardize **Note:** 2015-09-09 14:09:14 -07:00
Jessica Lord
47d103af72 Text edits 2015-09-01 16:21:29 -07:00
Jessica Lord
254cdc0e6c Text edits 2015-08-30 20:52:46 -07:00
Jessica Lord
2c6210cf9c Update code example 2015-08-30 20:52:37 -07:00
Jessica Lord
a38d34d368 Standardize native-image 2015-08-28 21:33:45 -07:00