Add notes about remote buffer in capturePage API's docs.
authorCheng Zhao <zcbenz@gmail.com>
Tue, 31 Dec 2013 02:00:29 +0000 (10:00 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Tue, 31 Dec 2013 02:00:29 +0000 (10:00 +0800)
docs/api/browser/browser-window.md

index e655f39d5988cc714b776cb63252a4bd426924f3..3500b9c6804025bc7dfd0fe04c135ffbd0072182 100644 (file)
@@ -309,6 +309,10 @@ visible page.
 You can write received `image` directly to a `.png` file, or you can base64
 encode it and use data URL to embed the image in HTML.
 
+**Note:** Be sure to read documents on remote buffer in
+[remote](../renderer/remote.md) if you are going to use this API in renderer
+process.
+
 ### BrowserWindow.getPageTitle()
 
 Returns the title of web page.