Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(3143)

Unified Diff: chrome/common/extensions/api/wallpaper.json

Issue 27335003: Add docs for chrome.wallpaper API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: new templkate syntax Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | chrome/common/extensions/docs/templates/intros/wallpaper.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/api/wallpaper.json
diff --git a/chrome/common/extensions/api/wallpaper.json b/chrome/common/extensions/api/wallpaper.json
index 59f7cb5be4765d5761d94a869ed795b610419783..a810b853f5b3a3273f546a55b85af154805de4a8 100644
--- a/chrome/common/extensions/api/wallpaper.json
+++ b/chrome/common/extensions/api/wallpaper.json
@@ -9,13 +9,12 @@
"implemented_in": "chrome/browser/chromeos/extensions/wallpaper_api.h"
},
"platforms": ["chromeos"],
- "description": "none",
+ "description": "Use the <code>chrome.wallpaper</code> API to change the ChromeOS wallpaper.",
"functions": [
{
"name": "setWallpaper",
"type": "function",
- "description": "Sets wallpaper to the image from url with specified layout",
- "nodoc": "true",
+ "description": "Sets wallpaper to the image at <em>url</em> or <em>wallpaperData</em> with the specified <em>layout</em>",
"parameters": [
{
"name": "details",
@@ -29,7 +28,7 @@
"url": {
"type": "string",
"optional": true,
- "description": "The url of online wallpaper."
+ "description": "The URL of the wallpaper to be set."
},
"layout": {
"type": "string",
@@ -38,7 +37,7 @@
},
"name": {
"type": "string",
- "description": "The file name of saved wallpaper."
+ "description": "The file name of the saved wallpaper."
},
"thumbnail": {
"type": "boolean",
@@ -54,7 +53,8 @@
{
"type": "binary",
"optional": true,
- "name": "thumbnail"
+ "name": "thumbnail",
+ "description": "The jpeg encoded wallpaper thumbnail. It is generated by resizing the wallpaper to 128x60."
}
]
}
« no previous file with comments | « no previous file | chrome/common/extensions/docs/templates/intros/wallpaper.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698