diff options
| author | evan.peterson.EP@gmail.com <evan.peterson.EP@gmail.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-23 04:24:55 +0000 |
|---|---|---|
| committer | evan.peterson.EP@gmail.com <evan.peterson.EP@gmail.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-23 04:24:55 +0000 |
| commit | 8426f8d77f00969b40a39f4d3b58f545e36ac9b3 (patch) | |
| tree | d36927b36e91387b08e038f83cab194d9301aae4 | |
| parent | 424088849de595795caeb5d947764021681114ba (diff) | |
| download | chromium_src-8426f8d77f00969b40a39f4d3b58f545e36ac9b3.zip chromium_src-8426f8d77f00969b40a39f4d3b58f545e36ac9b3.tar.gz chromium_src-8426f8d77f00969b40a39f4d3b58f545e36ac9b3.tar.bz2 | |
Add descriptions to all extension/app schemas, and enforce that they have them
from now on.
BUG=233968
R=kalman@chromium.org
TBR=yoz@chromium.org
Review URL: https://chromiumcodereview.appspot.com/16876004
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@208110 0039d316-1c4b-4281-b951-d872f2087c98
151 files changed, 281 insertions, 121 deletions
diff --git a/chrome/browser/performance_monitor/events.json b/chrome/browser/performance_monitor/events.json index ab5ffc6..3b04c35 100644 --- a/chrome/browser/performance_monitor/events.json +++ b/chrome/browser/performance_monitor/events.json @@ -5,6 +5,7 @@ [ { "namespace": "events", + "description": "Performance monitor events", "types": [ { "id": "ExtensionEvent", diff --git a/chrome/common/extensions/api/activity_log_private.json b/chrome/common/extensions/api/activity_log_private.json index 6336de2..72dbc46 100644 --- a/chrome/common/extensions/api/activity_log_private.json +++ b/chrome/common/extensions/api/activity_log_private.json @@ -5,6 +5,7 @@ [ { "namespace": "activityLogPrivate", + "description": "none", "types": [ { "id": "DomActivityDetail", diff --git a/chrome/common/extensions/api/alarms.idl b/chrome/common/extensions/api/alarms.idl index 9e610ad..3b218e0 100644 --- a/chrome/common/extensions/api/alarms.idl +++ b/chrome/common/extensions/api/alarms.idl @@ -2,8 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// TODO(mpcomplete): We need documentation before we can release this. - +// Use the <code>chrome.alarms</code> API to schedule code to run +// periodically or at a specified time in the future. namespace alarms { dictionary Alarm { // Name of this alarm. diff --git a/chrome/common/extensions/api/app.json b/chrome/common/extensions/api/app.json index 7735f63..d9bffa7 100644 --- a/chrome/common/extensions/api/app.json +++ b/chrome/common/extensions/api/app.json @@ -5,7 +5,7 @@ [ { "namespace": "app", - "nodoc": true, + "description": "none", "types": [ { "id": "Details", diff --git a/chrome/common/extensions/api/app_runtime.idl b/chrome/common/extensions/api/app_runtime.idl index 391adaa..da8ddb8 100644 --- a/chrome/common/extensions/api/app_runtime.idl +++ b/chrome/common/extensions/api/app_runtime.idl @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.app.runtime</code> API to manage the app lifecycle. +// The app runtime manages app installation, controls the event page, and can +// shut down the app at anytime. namespace app.runtime { [inline_doc] dictionary LaunchItem { diff --git a/chrome/common/extensions/api/app_window.idl b/chrome/common/extensions/api/app_window.idl index c4a258b..d4e1b40 100644 --- a/chrome/common/extensions/api/app_window.idl +++ b/chrome/common/extensions/api/app_window.idl @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.app.window</code> API to create windows. Windows +// have an optional frame with title bar and size controls. They are not +// associated with any Chrome browser windows. namespace app.window { dictionary Bounds { long? left; diff --git a/chrome/common/extensions/api/audio.idl b/chrome/common/extensions/api/audio.idl index 081889c..15efd77 100644 --- a/chrome/common/extensions/api/audio.idl +++ b/chrome/common/extensions/api/audio.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.audio</code> API to query audio device configuration and +// be notified when it changes. namespace audio { dictionary OutputDeviceInfo { diff --git a/chrome/common/extensions/api/bluetooth.idl b/chrome/common/extensions/api/bluetooth.idl index 0fd8be6..d1774b7 100644 --- a/chrome/common/extensions/api/bluetooth.idl +++ b/chrome/common/extensions/api/bluetooth.idl @@ -2,8 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// Bluetooth API. - +// Use the <code>chrome.bluetooth</code> API to connect to a Bluetooth +// device. namespace bluetooth { dictionary AdapterState { // The address of the adapter, in the format 'XX:XX:XX:XX:XX:XX'. diff --git a/chrome/common/extensions/api/bookmark_manager_private.json b/chrome/common/extensions/api/bookmark_manager_private.json index 8f573a3..192973a 100644 --- a/chrome/common/extensions/api/bookmark_manager_private.json +++ b/chrome/common/extensions/api/bookmark_manager_private.json @@ -5,6 +5,7 @@ [ { "namespace": "bookmarkManagerPrivate", + "description": "none", "nodoc": true, "types": [ { diff --git a/chrome/common/extensions/api/bookmarks.json b/chrome/common/extensions/api/bookmarks.json index 61ce218..e168362 100644 --- a/chrome/common/extensions/api/bookmarks.json +++ b/chrome/common/extensions/api/bookmarks.json @@ -5,6 +5,7 @@ [ { "namespace": "bookmarks", + "description": "Use the <code>chrome.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks. Also see <a href='override.html'>Override Pages</a>, which you can use to create a custom Bookmark Manager page.", "properties": { "MAX_WRITE_OPERATIONS_PER_HOUR": { "value": 100, diff --git a/chrome/common/extensions/api/browser_action.json b/chrome/common/extensions/api/browser_action.json index f734c4b..85dd9bb 100644 --- a/chrome/common/extensions/api/browser_action.json +++ b/chrome/common/extensions/api/browser_action.json @@ -5,6 +5,7 @@ [ { "namespace": "browserAction", + "description": "Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its <a href='#icon'>icon</a>, a browser action can also have a <a href='#tooltip'>tooltip</a>, a <a href='#badge'>badge</a>, and a <a href = '#popups'>popup</a>.", "types": [ { "id": "ColorArray", diff --git a/chrome/common/extensions/api/browsing_data.json b/chrome/common/extensions/api/browsing_data.json index 9d9824a..332186d 100644 --- a/chrome/common/extensions/api/browsing_data.json +++ b/chrome/common/extensions/api/browsing_data.json @@ -5,6 +5,7 @@ [ { "namespace": "browsingData", + "description": "Use the <code>chrome.browsingData</code> API to remove browsing data from a user's local profile.", "types": [ { "id": "RemovalOptions", diff --git a/chrome/common/extensions/api/chromeos_info_private.json b/chrome/common/extensions/api/chromeos_info_private.json index 4518da0..095edee 100644 --- a/chrome/common/extensions/api/chromeos_info_private.json +++ b/chrome/common/extensions/api/chromeos_info_private.json @@ -5,6 +5,7 @@ [ { "namespace": "chromeosInfoPrivate", + "description": "none", "compiler_options": { "implemented_in": "chrome/browser/chromeos/extensions/info_private_api.h" }, diff --git a/chrome/common/extensions/api/cloud_print_private.json b/chrome/common/extensions/api/cloud_print_private.json index c79a430..edd3e02 100644 --- a/chrome/common/extensions/api/cloud_print_private.json +++ b/chrome/common/extensions/api/cloud_print_private.json @@ -5,7 +5,7 @@ [ { "namespace": "cloudPrintPrivate", - "nodoc": "true", + "description": "none", "types": [ { "id": "PrinterSettings", diff --git a/chrome/common/extensions/api/command_line_private.json b/chrome/common/extensions/api/command_line_private.json index 2504376..90c052d 100644 --- a/chrome/common/extensions/api/command_line_private.json +++ b/chrome/common/extensions/api/command_line_private.json @@ -5,6 +5,7 @@ [ { "namespace": "commandLinePrivate", + "description": "none", "functions": [ { "name": "hasSwitch", diff --git a/chrome/common/extensions/api/commands.json b/chrome/common/extensions/api/commands.json index b064c9a..c02008e 100644 --- a/chrome/common/extensions/api/commands.json +++ b/chrome/common/extensions/api/commands.json @@ -5,6 +5,7 @@ [ { "namespace": "commands", + "description": "Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.", "types": [ { "id": "Command", diff --git a/chrome/common/extensions/api/content_settings.json b/chrome/common/extensions/api/content_settings.json index f9542d73..2a0b86a 100644 --- a/chrome/common/extensions/api/content_settings.json +++ b/chrome/common/extensions/api/content_settings.json @@ -5,6 +5,10 @@ [ { "namespace": "contentSettings", + "description": "Use the <code>chrome.contentSettings</code> API to change settings that control whether websites can use features such as cookies, JavaScript, and plug-ins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally.", + "compiler_options": { + "generate_type_functions": true + }, "types": [ { "id": "ResourceIdentifier", diff --git a/chrome/common/extensions/api/context_menus.json b/chrome/common/extensions/api/context_menus.json index e44322f..a96bbae 100644 --- a/chrome/common/extensions/api/context_menus.json +++ b/chrome/common/extensions/api/context_menus.json @@ -5,6 +5,7 @@ [ { "namespace": "contextMenus", + "description": "Use the <code>chrome.contextMenus</code> API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages.", "types": [ { "id": "OnClickData", diff --git a/chrome/common/extensions/api/cookies.json b/chrome/common/extensions/api/cookies.json index fc3e53f..8c083ac 100644 --- a/chrome/common/extensions/api/cookies.json +++ b/chrome/common/extensions/api/cookies.json @@ -5,6 +5,7 @@ [ { "namespace": "cookies", + "description": "Use the <code>chrome.cookies</code> API to query and modify cookies, and to be notified when they change.", "types": [ { "id": "Cookie", diff --git a/chrome/common/extensions/api/debugger.json b/chrome/common/extensions/api/debugger.json index fe2e08a..1150895 100644 --- a/chrome/common/extensions/api/debugger.json +++ b/chrome/common/extensions/api/debugger.json @@ -5,6 +5,7 @@ [ { "namespace": "debugger", + "description": "The <code>chrome.debugger</code> API serves as an alternate transport for Chrome's <a href='http://code.google.com/chrome/devtools/docs/remote-debugging.html'>remote debugging protocol</a>. Use <code>chrome.debugger</code> to attach to one or more tabs to instrument network interaction, debug JavaScript, mutate the DOM and CSS, etc. Use the Debuggee <code>tabId</code> to target tabs with sendCommand and route events by <code>tabId</code> from onEvent callbacks.", "types": [ { "id": "Debuggee", diff --git a/chrome/common/extensions/api/declarative_content.json b/chrome/common/extensions/api/declarative_content.json index f2e2ae2..bed20fc 100644 --- a/chrome/common/extensions/api/declarative_content.json +++ b/chrome/common/extensions/api/declarative_content.json @@ -5,6 +5,8 @@ [ { "namespace": "declarativeContent", + "description": "Use the <code>chrome.declarativeContent</code> API to take actions depending on the content of a page, without requiring permission to read the page's content.", + "documentation_permissions_required": ["declarative", "declarativeContent"], "types": [ { "id": "PageStateMatcher", diff --git a/chrome/common/extensions/api/declarative_web_request.json b/chrome/common/extensions/api/declarative_web_request.json index 4a99fbc..fdca489 100644 --- a/chrome/common/extensions/api/declarative_web_request.json +++ b/chrome/common/extensions/api/declarative_web_request.json @@ -5,6 +5,8 @@ [ { "namespace": "declarativeWebRequest", + "description": "Use the <code>chrome.declarativeWebRequest</code> API to intercept, block, or modify requests in-flight. It is significantly faster than the <a href='webRequest.html'><code>chrome.webRequest</code> API</a> because you can register rules that are evaluated in the browser rather than the JavaScript engine with reduces roundtrip latencies and allows higher efficiency.", + "documentation_permissions_required": ["declarative", "declarativeWebRequest"], "types": [ { "id": "HeaderFilter", diff --git a/chrome/common/extensions/api/developer_private.idl b/chrome/common/extensions/api/developer_private.idl index 740390c..059e19d 100644 --- a/chrome/common/extensions/api/developer_private.idl +++ b/chrome/common/extensions/api/developer_private.idl @@ -5,7 +5,6 @@ // developerPrivate API. // This is a private API exposing developing and debugging functionalities for // apps and extensions. - namespace developerPrivate { enum ItemType { diff --git a/chrome/common/extensions/api/devtools/experimental_audits.json b/chrome/common/extensions/api/devtools/experimental_audits.json index b9107bc..d359496 100644 --- a/chrome/common/extensions/api/devtools/experimental_audits.json +++ b/chrome/common/extensions/api/devtools/experimental_audits.json @@ -5,6 +5,7 @@ [ { "namespace": "experimental.devtools.audits", + "description": "Use the <code>chrome.experimental.devtools.audits</code> API to add new audit categories to the Developer Tools' Audit panel.", "nocompile": true, "functions": [ { diff --git a/chrome/common/extensions/api/devtools/experimental_console.json b/chrome/common/extensions/api/devtools/experimental_console.json index 35ea7f0..42fe4c7 100644 --- a/chrome/common/extensions/api/devtools/experimental_console.json +++ b/chrome/common/extensions/api/devtools/experimental_console.json @@ -5,6 +5,7 @@ [ { "namespace": "experimental.devtools.console", + "description": "Use the <code>chrome.experimental.devtools.console</code> API to retrieve messages from the inspected page console and post messages there.", "nocompile": true, "functions": [ { diff --git a/chrome/common/extensions/api/devtools/inspected_window.json b/chrome/common/extensions/api/devtools/inspected_window.json index 48346f8..bd5b764 100644 --- a/chrome/common/extensions/api/devtools/inspected_window.json +++ b/chrome/common/extensions/api/devtools/inspected_window.json @@ -5,6 +5,7 @@ [ { "namespace": "devtools.inspectedWindow", + "description": "Use the <code>chrome.devtools.inspectedWindow</code> API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.", "nocompile": true, "types": [ { diff --git a/chrome/common/extensions/api/devtools/network.json b/chrome/common/extensions/api/devtools/network.json index c7dc56e..3bb6e0b 100644 --- a/chrome/common/extensions/api/devtools/network.json +++ b/chrome/common/extensions/api/devtools/network.json @@ -5,6 +5,7 @@ [ { "namespace": "devtools.network", + "description": "Use the <code>chrome.devtools.network</code> API to retrieve the information about network requests displayed by the Developer Tools in the Network panel.", "nocompile": true, "types": [ { diff --git a/chrome/common/extensions/api/devtools/panels.json b/chrome/common/extensions/api/devtools/panels.json index de0635f..31ee936d 100644 --- a/chrome/common/extensions/api/devtools/panels.json +++ b/chrome/common/extensions/api/devtools/panels.json @@ -5,6 +5,7 @@ [ { "namespace": "devtools.panels", + "description": "Use the <code>chrome.devtools.panels</code> API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars.", "nocompile": true, "types": [ { diff --git a/chrome/common/extensions/api/diagnostics.idl b/chrome/common/extensions/api/diagnostics.idl index ba0af79..b498dbb 100644 --- a/chrome/common/extensions/api/diagnostics.idl +++ b/chrome/common/extensions/api/diagnostics.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.diagnostics</code> API to query various properties of +// the environment that may be useful for diagnostics. namespace diagnostics { dictionary SendPacketOptions { // Target IP address. @@ -20,7 +22,7 @@ namespace diagnostics { // The IP of the host which we recieves the ICMP reply from. // The IP may differs from our target IP if the packet's ttl is used up. DOMString ip; - + // Latency in millisenconds. double latency; }; diff --git a/chrome/common/extensions/api/dial.idl b/chrome/common/extensions/api/dial.idl index 42263b3..d16fdfd 100644 --- a/chrome/common/extensions/api/dial.idl +++ b/chrome/common/extensions/api/dial.idl @@ -2,34 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// An API for discovery of devices that support DIAL. +// Use the <code>chrome.dial</code> API to discover devices that support DIAL. // Protocol specification: http://www.dial-multiscreen.org/ -// -// The API is backed by a service that multicasts discovery requests on the -// local network to discover DIAL-capable devices and maintains a list of -// devices that have responded. Adding an onDeviceList listener causes the -// service to periodically issue discovery requests to maintain the device list. -// (No polling is done when there are no onDeviceList listeners.) -// -// The onDeviceList event is fired when discovery respnses are received and in -// other circumstances; see the documentation for onDeviceList. -// -// The client can request that network discovery can be done immediately by -// invoking discoverNow() which is useful for presenting the user with an -// updated list of devices. -// -// On-demand use (updates when discoverNow() is called): -// chrome.dial.onDeviceList.addListener(function (list) { updateMenu(list); }); -// chrome.dial.discoverNow(); -// (Remember to remove the listener when the menu closes.) -// -// Background use (updates only when periodic polling happens): -// var myList; -// chrome.dial.onDeviceList.addListener(function (list) { myList = list; }); -// -// These can be combined to poll for devices to prime the device menu, then -// refresh the menu when it is displayed. - namespace dial { // Represents a unique device that responded to a DIAL discovery request. diff --git a/chrome/common/extensions/api/downloads.idl b/chrome/common/extensions/api/downloads.idl index f306f08..af6eac1 100644 --- a/chrome/common/extensions/api/downloads.idl +++ b/chrome/common/extensions/api/downloads.idl @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.downloads</code> API to programmatically initiate, +// monitor, manipulate, and search for downloads. +[permissions=downloads] namespace downloads { [inline_doc] dictionary HeaderNameValuePair { // Name of the HTTP header. diff --git a/chrome/common/extensions/api/downloads_internal.idl b/chrome/common/extensions/api/downloads_internal.idl index 1e5b910..bbbfbcd1 100644 --- a/chrome/common/extensions/api/downloads_internal.idl +++ b/chrome/common/extensions/api/downloads_internal.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// downloadsInternal [nodoc=true] namespace downloadsInternal { interface Functions { @@ -10,7 +11,4 @@ namespace downloadsInternal { DOMString filename, DOMString conflict_action); }; - - interface Events { - }; }; diff --git a/chrome/common/extensions/api/echo_private.json b/chrome/common/extensions/api/echo_private.json index c5b9371..2d1a40f 100644 --- a/chrome/common/extensions/api/echo_private.json +++ b/chrome/common/extensions/api/echo_private.json @@ -8,9 +8,8 @@ "compiler_options": { "implemented_in": "chrome/browser/chromeos/extensions/echo_private_api.h" }, - "nodoc": true, + "description": "none", "platforms": ["chromeos"], - "types": [], "functions": [ { "name": "getRegistrationCode", diff --git a/chrome/common/extensions/api/enterprise_platform_keys_private.json b/chrome/common/extensions/api/enterprise_platform_keys_private.json index 483586c..8c66814 100644 --- a/chrome/common/extensions/api/enterprise_platform_keys_private.json +++ b/chrome/common/extensions/api/enterprise_platform_keys_private.json @@ -5,9 +5,8 @@ [ { "namespace": "enterprise.platformKeysPrivate", - "nodoc": true, + "description": "none", "platforms": ["chromeos"], - "types": [], "functions": [ { "name": "challengeMachineKey", diff --git a/chrome/common/extensions/api/events.json b/chrome/common/extensions/api/events.json index 66fdf3d..b67b8b0 100644 --- a/chrome/common/extensions/api/events.json +++ b/chrome/common/extensions/api/events.json @@ -5,6 +5,7 @@ [ { "namespace": "events", + "description": "Use the <code>chrome.events</code> API to notify you when something interesting happens.", "compiler_options": { "implemented_in": "chrome/browser/extensions/api/declarative/declarative_api.h" }, diff --git a/chrome/common/extensions/api/experimental_accessibility.json b/chrome/common/extensions/api/experimental_accessibility.json index 5a733dc..da3536e 100644 --- a/chrome/common/extensions/api/experimental_accessibility.json +++ b/chrome/common/extensions/api/experimental_accessibility.json @@ -8,7 +8,7 @@ "compiler_options": { "implemented_in": "chrome/browser/accessibility/accessibility_extension_api.h" }, - "nodoc": true, + "description": "none", "types": [ { "id": "CheckboxDetails", diff --git a/chrome/common/extensions/api/experimental_discovery.idl b/chrome/common/extensions/api/experimental_discovery.idl index d8b4e5e..4f631c3 100644 --- a/chrome/common/extensions/api/experimental_discovery.idl +++ b/chrome/common/extensions/api/experimental_discovery.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// An experimental API that allows extensions to inject suggest links in the recommended pane of the New Tab Page. namespace experimental.discovery { dictionary SuggestDetails { diff --git a/chrome/common/extensions/api/experimental_dns.idl b/chrome/common/extensions/api/experimental_dns.idl index 23c5c4b..04de6ad 100644 --- a/chrome/common/extensions/api/experimental_dns.idl +++ b/chrome/common/extensions/api/experimental_dns.idl @@ -2,7 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -[nodoc] namespace experimental.dns { +// Experimental.dns. +namespace experimental.dns { dictionary ResolveCallbackResolveInfo { // The result code. Zero indicates success. diff --git a/chrome/common/extensions/api/experimental_history.json b/chrome/common/extensions/api/experimental_history.json index 09a6f8e..f7f2290 100644 --- a/chrome/common/extensions/api/experimental_history.json +++ b/chrome/common/extensions/api/experimental_history.json @@ -5,6 +5,7 @@ [ { "namespace": "experimental.history", + "description": "Use the <code>chrome.experimental.history</code> API to interact with the browser's record of most visited pages.", "types": [ { "id": "MostVisitedItem", diff --git a/chrome/common/extensions/api/experimental_identity.idl b/chrome/common/extensions/api/experimental_identity.idl index 1f2bf1f..9bcee6b 100644 --- a/chrome/common/extensions/api/experimental_identity.idl +++ b/chrome/common/extensions/api/experimental_identity.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// The <code>chrome.experimental.identity</code> API. namespace experimental.identity { [inline_doc] dictionary ExperimentalTokenDetails { diff --git a/chrome/common/extensions/api/experimental_idltest.idl b/chrome/common/extensions/api/experimental_idltest.idl index 4ee9ff7..5e85ce7 100644 --- a/chrome/common/extensions/api/experimental_idltest.idl +++ b/chrome/common/extensions/api/experimental_idltest.idl @@ -3,8 +3,7 @@ // found in the LICENSE file. // An API to test IDL schema specifications. - -[nodoc] namespace experimental.idltest { +namespace experimental.idltest { callback LongArrayCallback = void(long[] array); callback ArrayBufferCallback = void(ArrayBuffer buffer); diff --git a/chrome/common/extensions/api/experimental_infobars.json b/chrome/common/extensions/api/experimental_infobars.json index 220f679..ec3cfdd 100644 --- a/chrome/common/extensions/api/experimental_infobars.json +++ b/chrome/common/extensions/api/experimental_infobars.json @@ -5,6 +5,7 @@ [ { "namespace": "experimental.infobars", + "description": "Use the <code>chrome.infobars</code> API to add a horizontal panel just above a tab's contents. See the screenshot below.", "compiler_options": { "implemented_in": "chrome/browser/infobars/infobar_extension_api.h" }, diff --git a/chrome/common/extensions/api/experimental_input_virtual_keyboard.json b/chrome/common/extensions/api/experimental_input_virtual_keyboard.json index fc8f1b0..4bd2c81 100644 --- a/chrome/common/extensions/api/experimental_input_virtual_keyboard.json +++ b/chrome/common/extensions/api/experimental_input_virtual_keyboard.json @@ -5,8 +5,7 @@ [ { "namespace": "experimental.input.virtualKeyboard", - "nodoc": true, - "types": [], + "description": "none", "functions": [ { "name": "insertText", diff --git a/chrome/common/extensions/api/experimental_media_galleries.idl b/chrome/common/extensions/api/experimental_media_galleries.idl index 0ada32e..649bd95 100644 --- a/chrome/common/extensions/api/experimental_media_galleries.idl +++ b/chrome/common/extensions/api/experimental_media_galleries.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// An experimental API that expands upon the <code>chrome.mediaGalleries</code> +// API's functionality. namespace experimental.mediaGalleries { callback AssembleMediaFileCallback = diff --git a/chrome/common/extensions/api/experimental_processes.json b/chrome/common/extensions/api/experimental_processes.json index 5fdeebc..9bb7633 100644 --- a/chrome/common/extensions/api/experimental_processes.json +++ b/chrome/common/extensions/api/experimental_processes.json @@ -5,6 +5,7 @@ [ { "namespace": "experimental.processes", + "description": "Use the <code>chrome.experimental.processes</code> API to interact with the browser's processes.", "types": [ { "id": "Process", @@ -13,7 +14,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique ID of the process provided by the browser." + "description": "Unique ID of the process provided by the browser." }, "osProcessId": { "type": "integer", diff --git a/chrome/common/extensions/api/experimental_record.json b/chrome/common/extensions/api/experimental_record.json index ce55501..cf95448 100644 --- a/chrome/common/extensions/api/experimental_record.json +++ b/chrome/common/extensions/api/experimental_record.json @@ -1,6 +1,7 @@ [ { "namespace": "experimental.record", + "description": "The <code>chrome.experimental.record</code> API.", "types": [ { "id": "SessionDetails", @@ -10,7 +11,7 @@ "extensionPath": { "type": "string", "optional": true, - "description": + "description": "Absolute path to an unpacked extension to run in the subbrowser session." } } @@ -80,7 +81,7 @@ "description": "Unique name of capture. Use to determine cache." }, { - "type": "integer", + "type": "integer", "name": "repeatCount", "minimum": 0, "maximum": 100 diff --git a/chrome/common/extensions/api/experimental_rlz.json b/chrome/common/extensions/api/experimental_rlz.json index b954a4e..f97f925e 100644 --- a/chrome/common/extensions/api/experimental_rlz.json +++ b/chrome/common/extensions/api/experimental_rlz.json @@ -5,8 +5,7 @@ [ { "namespace": "experimental.rlz", - "nodoc": true, - "types": [], + "description": "none", "functions": [ { "name": "recordProductEvent", diff --git a/chrome/common/extensions/api/experimental_system_info_storage.idl b/chrome/common/extensions/api/experimental_system_info_storage.idl index d6d5002..85ad898 100644 --- a/chrome/common/extensions/api/experimental_system_info_storage.idl +++ b/chrome/common/extensions/api/experimental_system_info_storage.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.experimental.systemInfo.storage</code> API to query +// storage device information and be notified when it changes. namespace experimental.systemInfo.storage { enum StorageUnitType { @@ -73,6 +75,6 @@ namespace experimental.systemInfo.storage { // Fired when a removable storage is detached from the system. static void onDetached(DOMString id); }; - + }; diff --git a/chrome/common/extensions/api/extension.json b/chrome/common/extensions/api/extension.json index 17cdc32..cd53553 100644 --- a/chrome/common/extensions/api/extension.json +++ b/chrome/common/extensions/api/extension.json @@ -5,6 +5,7 @@ [ { "namespace": "extension", + "description": "The <code>chrome.extension</code> API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in <a href='messaging.html'>Message Passing</a>.", "compiler_options": { "implemented_in": "chrome/browser/extensions/api/module/module.h" }, diff --git a/chrome/common/extensions/api/feedback_private.idl b/chrome/common/extensions/api/feedback_private.idl index faa579d..97ce494 100644 --- a/chrome/common/extensions/api/feedback_private.idl +++ b/chrome/common/extensions/api/feedback_private.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// A private API for accessing feedback reports sent by a user. namespace feedbackPrivate { dictionary AttachedFile { diff --git a/chrome/common/extensions/api/file_browser_handler.json b/chrome/common/extensions/api/file_browser_handler.json index 2eb694c..ed05911 100644 --- a/chrome/common/extensions/api/file_browser_handler.json +++ b/chrome/common/extensions/api/file_browser_handler.json @@ -5,6 +5,7 @@ [ { "namespace":"fileBrowserHandler", + "description": "Use the <code>chrome.fileBrowserHandler</code> API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website.", "platforms": ["chromeos"], "types": [ { diff --git a/chrome/common/extensions/api/file_browser_handler_internal.json b/chrome/common/extensions/api/file_browser_handler_internal.json index c4461ed..af42611 100644 --- a/chrome/common/extensions/api/file_browser_handler_internal.json +++ b/chrome/common/extensions/api/file_browser_handler_internal.json @@ -8,7 +8,7 @@ "compiler_options": { "implemented_in": "chrome/browser/chromeos/extensions/file_manager/file_browser_handler_api.h" }, - "nodoc": true, + "description": "none", "platforms": ["chromeos"], "types": [ { diff --git a/chrome/common/extensions/api/file_browser_private.json b/chrome/common/extensions/api/file_browser_private.json index 8e44a6a..132a56a 100644 --- a/chrome/common/extensions/api/file_browser_private.json +++ b/chrome/common/extensions/api/file_browser_private.json @@ -5,7 +5,7 @@ [ { "namespace":"fileBrowserPrivate", - "nodoc": "true", + "description": "none", "types": [ { "id": "FileBrowserTask", @@ -450,7 +450,7 @@ "optional": true, "parameters": [] } - ] + ] }, { "name": "getFileTasks", @@ -1136,7 +1136,7 @@ { "name": "callback", "type": "function", - "description": "Called back when the check is finished.", + "description": "Called back when the check is finished.", "parameters": [ { "name": "result", diff --git a/chrome/common/extensions/api/file_system.idl b/chrome/common/extensions/api/file_system.idl index 89db7df..e2bd173 100644 --- a/chrome/common/extensions/api/file_system.idl +++ b/chrome/common/extensions/api/file_system.idl @@ -2,6 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.fileSystem</code> API to create, read, navigate, +// and write to a sandboxed section of the user's local file system. With this +// API, packaged apps can read and write to a user-seleced location. For +// example, a text editor app can use the API to read and write local documents. namespace fileSystem { dictionary AcceptOption { // This is the optional text description for this option. If not present, diff --git a/chrome/common/extensions/api/font_settings.json b/chrome/common/extensions/api/font_settings.json index 0719147..1999fcf 100644 --- a/chrome/common/extensions/api/font_settings.json +++ b/chrome/common/extensions/api/font_settings.json @@ -5,6 +5,8 @@ [ { "namespace": "fontSettings", + "description": "Use the <code>chrome.fontSettings</code> API to manage Chrome's font settings.", + "documentation_permissions_required": ["fontSettings"], "types": [ { "id": "FontName", diff --git a/chrome/common/extensions/api/history.json b/chrome/common/extensions/api/history.json index c72caee..b73e3e3 100644 --- a/chrome/common/extensions/api/history.json +++ b/chrome/common/extensions/api/history.json @@ -5,6 +5,7 @@ [ { "namespace": "history", + "description": "Use the <code>chrome.history</code> API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see <a href='override.html'>Override Pages</a>.", "types": [ { "id": "HistoryItem", diff --git a/chrome/common/extensions/api/i18n.json b/chrome/common/extensions/api/i18n.json index e568913..510256c 100644 --- a/chrome/common/extensions/api/i18n.json +++ b/chrome/common/extensions/api/i18n.json @@ -5,6 +5,7 @@ [ { "namespace": "i18n", + "description": "Use the <code>chrome.i18n</code> infrastructure to implement internationalization across your whole app or extension.", "types": [], "functions": [ { diff --git a/chrome/common/extensions/api/identity.idl b/chrome/common/extensions/api/identity.idl index aacdd84..a518762 100644 --- a/chrome/common/extensions/api/identity.idl +++ b/chrome/common/extensions/api/identity.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// TODO(courage): documentation. namespace identity { [nodoc] dictionary TokenDetails { diff --git a/chrome/common/extensions/api/identity_private.idl b/chrome/common/extensions/api/identity_private.idl index 2f44ffe..201d4b6 100644 --- a/chrome/common/extensions/api/identity_private.idl +++ b/chrome/common/extensions/api/identity_private.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// identityPrivate. namespace identityPrivate { callback GetResourcesCallback = void (object result); diff --git a/chrome/common/extensions/api/idle.json b/chrome/common/extensions/api/idle.json index 3672056..153e931 100644 --- a/chrome/common/extensions/api/idle.json +++ b/chrome/common/extensions/api/idle.json @@ -5,6 +5,7 @@ [ { "namespace": "idle", + "description": "Use the <code>chrome.idle</code> API to detect when the machine's idle state changes.", "types": [], "functions": [ { diff --git a/chrome/common/extensions/api/input_ime.json b/chrome/common/extensions/api/input_ime.json index ce2cfc9..9a7b170 100644 --- a/chrome/common/extensions/api/input_ime.json +++ b/chrome/common/extensions/api/input_ime.json @@ -5,6 +5,7 @@ [ { "namespace": "input.ime", + "description": "Use the <code>chrome.input.ime</code> API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window.", "platforms": ["chromeos"], "types": [ { diff --git a/chrome/common/extensions/api/input_method_private.json b/chrome/common/extensions/api/input_method_private.json index d49c099..9b40b62 100644 --- a/chrome/common/extensions/api/input_method_private.json +++ b/chrome/common/extensions/api/input_method_private.json @@ -5,9 +5,8 @@ [ { "namespace": "inputMethodPrivate", - "nodoc": true, "platforms": ["chromeos"], - "types": [], + "description": "none", "functions": [ { "name": "get", diff --git a/chrome/common/extensions/api/location.idl b/chrome/common/extensions/api/location.idl index 9a33ee0..0900c8f 100644 --- a/chrome/common/extensions/api/location.idl +++ b/chrome/common/extensions/api/location.idl @@ -1,8 +1,11 @@ // Copyright (c) 2013 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. - // TODO(vadimt): Consider reusing WebKit/Blink types, if this is possible. + +// The <code>chrome.location</code> API augments the events from the +// <a href="http://dev.w3.org/geo/api/spec-source.html">HTML Geolocation API</a> +// to be event page compatible. namespace location { // Coordinates part of the Location object. dictionary Coordinates { diff --git a/chrome/common/extensions/api/management.json b/chrome/common/extensions/api/management.json index c4890f1..8ac1f07 100644 --- a/chrome/common/extensions/api/management.json +++ b/chrome/common/extensions/api/management.json @@ -5,6 +5,7 @@ [ { "namespace":"management", + "description": "The <code>chrome.management</code> API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that <a href='override.html'>override</a> the built-in New Tab page.", "types": [ { "id": "IconInfo", diff --git a/chrome/common/extensions/api/manifest_types.json b/chrome/common/extensions/api/manifest_types.json index 4f9588a..4fc77ed 100644 --- a/chrome/common/extensions/api/manifest_types.json +++ b/chrome/common/extensions/api/manifest_types.json @@ -8,6 +8,7 @@ [ { "namespace": "manifestTypes", + "description": "Schemas for structured manfiest entries", "types": [ { "id": "ExternallyConnectable", diff --git a/chrome/common/extensions/api/media_galleries.idl b/chrome/common/extensions/api/media_galleries.idl index d2267ba..0cd469b 100644 --- a/chrome/common/extensions/api/media_galleries.idl +++ b/chrome/common/extensions/api/media_galleries.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.mediaGalleries</code> API to access media files (images, +// video, audio) from the user's local disks (with the user's consent). namespace mediaGalleries { [inline_doc] enum GetMediaFileSystemsInteractivity { diff --git a/chrome/common/extensions/api/media_galleries_private.idl b/chrome/common/extensions/api/media_galleries_private.idl index 80acb0f..ecf2a52 100644 --- a/chrome/common/extensions/api/media_galleries_private.idl +++ b/chrome/common/extensions/api/media_galleries_private.idl @@ -4,7 +4,8 @@ // This is a private API for M23. This will be superceded by the // systeminfo.storage API in M24. - +// This API's description needs to be updated. Issue: +// https://code.google.com/p/chromium/issues/detail?id=252048 namespace mediaGalleriesPrivate { // A dictionary that describes an attached device. [inline_doc] dictionary DeviceAttachmentDetails { diff --git a/chrome/common/extensions/api/media_player_private.json b/chrome/common/extensions/api/media_player_private.json index 60f394c..da31398 100644 --- a/chrome/common/extensions/api/media_player_private.json +++ b/chrome/common/extensions/api/media_player_private.json @@ -5,10 +5,10 @@ [ { "namespace": "mediaPlayerPrivate", - "nodoc": "true", "compiler_options": { "implemented_in": "chrome/browser/chromeos/extensions/media_player_api.h" }, + "description": "none", "platforms": ["chromeos"], "types": [ { diff --git a/chrome/common/extensions/api/metrics_private.json b/chrome/common/extensions/api/metrics_private.json index 7b4f7b1..627687c 100644 --- a/chrome/common/extensions/api/metrics_private.json +++ b/chrome/common/extensions/api/metrics_private.json @@ -5,7 +5,7 @@ [ { "namespace": "metricsPrivate", - "nodoc": true, + "description": "none", "types": [ { "id": "MetricType", diff --git a/chrome/common/extensions/api/music_manager_private.idl b/chrome/common/extensions/api/music_manager_private.idl index 5997d70..d1dbfae 100644 --- a/chrome/common/extensions/api/music_manager_private.idl +++ b/chrome/common/extensions/api/music_manager_private.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// musicManagerPrivate. [nodoc] namespace musicManagerPrivate { callback GetDeviceIdCallback = void (DOMString device_id); diff --git a/chrome/common/extensions/api/networking_private.json b/chrome/common/extensions/api/networking_private.json index b0901c5..14640ef 100644 --- a/chrome/common/extensions/api/networking_private.json +++ b/chrome/common/extensions/api/networking_private.json @@ -5,6 +5,7 @@ [ { "namespace":"networkingPrivate", + "description": "none", "compiler_options": { "implemented_in": "chrome/browser/chromeos/extensions/networking_private_api.h" }, diff --git a/chrome/common/extensions/api/notifications.idl b/chrome/common/extensions/api/notifications.idl index cba11d4..321cd5c 100644 --- a/chrome/common/extensions/api/notifications.idl +++ b/chrome/common/extensions/api/notifications.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.notifications</code> API to create rich notifications +// using templates and show these notifications to users in the system tray. namespace notifications { [noinline_doc] enum TemplateType { // icon, title, message, expandedMessage, up to two buttons diff --git a/chrome/common/extensions/api/omnibox.json b/chrome/common/extensions/api/omnibox.json index a9e51e5a..9d43836 100644 --- a/chrome/common/extensions/api/omnibox.json +++ b/chrome/common/extensions/api/omnibox.json @@ -5,6 +5,7 @@ [ { "namespace": "omnibox", + "description": "The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.", "types": [ { "id": "SuggestResult", diff --git a/chrome/common/extensions/api/page_action.json b/chrome/common/extensions/api/page_action.json index 5214283..09c4964 100644 --- a/chrome/common/extensions/api/page_action.json +++ b/chrome/common/extensions/api/page_action.json @@ -5,6 +5,7 @@ [ { "namespace": "pageAction", + "description": "Use the <code>chrome.pageAction</code> API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.", "types": [ { "id": "ImageDataType", diff --git a/chrome/common/extensions/api/page_actions.json b/chrome/common/extensions/api/page_actions.json index 7283439..d991860 100644 --- a/chrome/common/extensions/api/page_actions.json +++ b/chrome/common/extensions/api/page_actions.json @@ -5,9 +5,8 @@ [ { "namespace": "pageActions", - "nodoc": true, + "description": "none", "maximumManifestVersion": 1, - "types": [], "functions": [ { "name": "enableForTab", diff --git a/chrome/common/extensions/api/page_capture.json b/chrome/common/extensions/api/page_capture.json index 5c97410..f796d69 100644 --- a/chrome/common/extensions/api/page_capture.json +++ b/chrome/common/extensions/api/page_capture.json @@ -5,6 +5,7 @@ [ { "namespace": "pageCapture", + "description": "Use the <code>chrome.pageCapture</code> API to save a tab as MHTML.", "functions": [ { "name": "saveAsMHTML", diff --git a/chrome/common/extensions/api/page_launcher.idl b/chrome/common/extensions/api/page_launcher.idl index deef68a..fceab2b 100644 --- a/chrome/common/extensions/api/page_launcher.idl +++ b/chrome/common/extensions/api/page_launcher.idl @@ -2,9 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// This module allows platform apps an additional way of launching themselves -// from the browser. To use this api, an app needs to specify the page_launcher -// manifest property, then register to listen to pageLauncher.onClicked events. +// Use the <code>chrome.pageLauncher</code> API to provide platform apps with +// an additional way of launching themselves from the browser. To use this api, +// an app needs to specify the page_launcher manifest property, then register to +// listen to pageLauncher.onClicked events. namespace pageLauncher { // Information about the page the user was on when the event was fired. dictionary PageData { diff --git a/chrome/common/extensions/api/permissions.json b/chrome/common/extensions/api/permissions.json index d4a8689..f6a03b7 100644 --- a/chrome/common/extensions/api/permissions.json +++ b/chrome/common/extensions/api/permissions.json @@ -5,6 +5,7 @@ [ { "namespace": "permissions", + "description": "Use the <code>chrome.permissions</code> API to implement optional permissions. As of Chrome 16, you can request optional permissions during your extension's regular application flow rather than at install time, so users understand why the permissions are needed and use only those that are necessary.", "types": [ { "id": "Permissions", diff --git a/chrome/common/extensions/api/preferences_private.json b/chrome/common/extensions/api/preferences_private.json index ea64053..c68b08d 100644 --- a/chrome/common/extensions/api/preferences_private.json +++ b/chrome/common/extensions/api/preferences_private.json @@ -5,7 +5,7 @@ [ { "namespace": "preferencesPrivate", - "nodoc": true, + "description": "none", "properties": { "googleGeolocationAccessEnabled": { "$ref": "types.ChromeSetting", diff --git a/chrome/common/extensions/api/privacy.json b/chrome/common/extensions/api/privacy.json index abf4073..03845c9 100644 --- a/chrome/common/extensions/api/privacy.json +++ b/chrome/common/extensions/api/privacy.json @@ -5,6 +5,7 @@ [ { "namespace": "privacy", + "description": "Use the <code>chrome.privacy</code> API to control usage of the features in Chrome that can affect a user's privacy. This API relies on the <a href='types.html#ChromeSetting'>ChromeSetting prototype of the type API</a> for getting and setting Chrome's configuration.", "properties": { "network": { "type": "object", diff --git a/chrome/common/extensions/api/proxy.json b/chrome/common/extensions/api/proxy.json index 9eabd8c..2d28bb6 100644 --- a/chrome/common/extensions/api/proxy.json +++ b/chrome/common/extensions/api/proxy.json @@ -5,6 +5,7 @@ [ { "namespace": "proxy", + "description": "Use the <code>chrome.proxy</code> API to manage Chrome's proxy settings. This API relies on the <a href='types.html#ChromeSetting'>ChromeSetting prototype of the type API</a> for getting and setting the proxy configuration.", "types": [ { "id": "ProxyServer", diff --git a/chrome/common/extensions/api/push_messaging.idl b/chrome/common/extensions/api/push_messaging.idl index 9cdf753..7d3f417 100644 --- a/chrome/common/extensions/api/push_messaging.idl +++ b/chrome/common/extensions/api/push_messaging.idl @@ -2,7 +2,10 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -namespace pushMessaging{ +// Use <code>chrome.pushMessaging</code> to enable apps and extensions to +// receive message data sent through +// <a href="cloudMessaging">Google Cloud Messaging</a>. +namespace pushMessaging { dictionary Message { // The subchannel the message was sent on; diff --git a/chrome/common/extensions/api/rtc_private.idl b/chrome/common/extensions/api/rtc_private.idl index 88e775f..73e26af 100644 --- a/chrome/common/extensions/api/rtc_private.idl +++ b/chrome/common/extensions/api/rtc_private.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// rtcPrivate. namespace rtcPrivate { // Launch action type. enum ActionType {chat, voice, video}; diff --git a/chrome/common/extensions/api/runtime.json b/chrome/common/extensions/api/runtime.json index d3bef58..d1a1d3a 100644 --- a/chrome/common/extensions/api/runtime.json +++ b/chrome/common/extensions/api/runtime.json @@ -5,6 +5,8 @@ [ { "namespace": "runtime", + "description": "Use the <code>chrome.runtime</code> API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs.", + "documentation_permissions_required": ["runtime"], "types": [ { "id": "Port", diff --git a/chrome/common/extensions/api/script_badge.json b/chrome/common/extensions/api/script_badge.json index 43df1e0..e9051c2 100644 --- a/chrome/common/extensions/api/script_badge.json +++ b/chrome/common/extensions/api/script_badge.json @@ -5,6 +5,7 @@ [ { "namespace": "scriptBadge", + "description": "Use the <code>chrome.scriptBadge</code> API to control the behaviour of the script badge.", "functions": [ { "name": "setPopup", diff --git a/chrome/common/extensions/api/serial.idl b/chrome/common/extensions/api/serial.idl index 6aad781..1df7550 100644 --- a/chrome/common/extensions/api/serial.idl +++ b/chrome/common/extensions/api/serial.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.serial</code> API to read from and write to a device +// connected to a serial port. namespace serial { callback GetPortsCallback = void (DOMString[] ports); diff --git a/chrome/common/extensions/api/session_restore.json b/chrome/common/extensions/api/session_restore.json index 6071194..e44a59c 100644 --- a/chrome/common/extensions/api/session_restore.json +++ b/chrome/common/extensions/api/session_restore.json @@ -5,6 +5,7 @@ [ { "namespace": "sessionRestore", + "description": "Use the <code>chrome.sessionRestore</code> API to query and restore tabs and windows from a browsing session.", "types": [ { "id": "ClosedEntry", @@ -26,7 +27,7 @@ { "type": "object", "name": "options", - "optional": true, + "optional": true, "properties": { "maxResults": { "type": "integer", diff --git a/chrome/common/extensions/api/socket.idl b/chrome/common/extensions/api/socket.idl index 4bc6068..e727d84 100644 --- a/chrome/common/extensions/api/socket.idl +++ b/chrome/common/extensions/api/socket.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.socket</code> API to send and receive data over the +// network using TCP and UDP connections. namespace socket { enum SocketType { tcp, @@ -267,18 +269,18 @@ namespace socket { // before calling this method. // |socketId| : The socketId. // |address| : The group address to join. Domain names are not supported. - // |callback| : Called when the join group operation is done with an + // |callback| : Called when the join group operation is done with an // integer parameter indicating the platform-independent error code. static void joinGroup(long socketId, DOMString address, JoinGroupCallback callback); // Leave the multicast group previously joined using <code>joinGroup</code>. - // It's not necessary to leave the multicast group before destroying the + // It's not necessary to leave the multicast group before destroying the // socket or exiting. This is automatically called by the OS. // - // Leaving the group will prevent the router from sending multicast - // datagrams to the local host, presuming no other process on the host is + // Leaving the group will prevent the router from sending multicast + // datagrams to the local host, presuming no other process on the host is // still joined to the group. // // |socketId| : The socketId. @@ -300,7 +302,7 @@ namespace socket { long ttl, SetMulticastTimeToLiveCallback callback); - // Set whether multicast packets sent from the host to the multicast + // Set whether multicast packets sent from the host to the multicast // group will be looped back to the host. // // Note: the behavior of <code>setMulticastLoopbackMode</code> is slightly diff --git a/chrome/common/extensions/api/storage.json b/chrome/common/extensions/api/storage.json index db7d7fa..e1bcf98 100644 --- a/chrome/common/extensions/api/storage.json +++ b/chrome/common/extensions/api/storage.json @@ -5,6 +5,8 @@ [ { "namespace": "storage", + "description": "Use the <code>chrome.storage</code> API to store, retrieve, and track changes to user data.", + "unprivileged": true, "types": [ { "id": "StorageChange", diff --git a/chrome/common/extensions/api/streams_private.json b/chrome/common/extensions/api/streams_private.json index f6134e0..f248345 100644 --- a/chrome/common/extensions/api/streams_private.json +++ b/chrome/common/extensions/api/streams_private.json @@ -5,9 +5,7 @@ [ { "namespace":"streamsPrivate", - "types": [ - ], - + "description": "none", "events": [ { "name": "onExecuteMimeTypeHandler", diff --git a/chrome/common/extensions/api/sync_file_system.idl b/chrome/common/extensions/api/sync_file_system.idl index c772c70..3c7afb1 100644 --- a/chrome/common/extensions/api/sync_file_system.idl +++ b/chrome/common/extensions/api/sync_file_system.idl @@ -2,6 +2,13 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.syncFileSystem</code> API to save and synchronize data +// on Google Drive. This API is NOT for accessing arbitrary user docs stored in +// Google Drive. It provides app-specific syncable storage for offline and +// caching usage so that the same data can be available across different +// clients. Read +// <a href="http://developer.chrome.com/trunk/apps/app_storage.html">Manage +// Data</a> for more on using this API. namespace syncFileSystem { enum SyncAction { added, updated, deleted diff --git a/chrome/common/extensions/api/system_info_cpu.idl b/chrome/common/extensions/api/system_info_cpu.idl index ee61007..cb54340 100644 --- a/chrome/common/extensions/api/system_info_cpu.idl +++ b/chrome/common/extensions/api/system_info_cpu.idl @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// File-level comment to appease parser. Eventually this will not be necessary. +// Use the <code>systemInfo.cpu</code> API to query CPU metadata. namespace systemInfo.cpu { dictionary CpuInfo { @@ -15,7 +15,7 @@ namespace systemInfo.cpu { }; callback CpuInfoCallback = void (CpuInfo info); - + interface Functions { // Queries basic CPU information of the system. static void get(CpuInfoCallback callback); diff --git a/chrome/common/extensions/api/system_info_display.idl b/chrome/common/extensions/api/system_info_display.idl index cf225e3..71c4a8b 100644 --- a/chrome/common/extensions/api/system_info_display.idl +++ b/chrome/common/extensions/api/system_info_display.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>systemInfo.display</code> API to query display metadata. namespace systemInfo.display { dictionary Bounds { @@ -35,16 +36,16 @@ namespace systemInfo.display { dictionary DisplayUnitInfo { // The unique identifier of the display. DOMString id; - + // The user-friendly name (e.g. "HP LCD monitor"). DOMString name; - + // Identifier of the display that is being mirrored on the display unit. // If mirroring is not in progress, set to an empty string. // Currently exposed only on ChromeOS. Will be empty string on other // platforms. DOMString mirroringSourceId; - + // True if this is the primary display. boolean isPrimary; @@ -87,22 +88,22 @@ namespace systemInfo.display { // the specified id (if mirroring is in progress). // If set, no other parameter may be set. DOMString? mirroringSourceId; - + // If set to true, makes the display primary. No-op if set to false. boolean? isPrimary; - + // If set, sets the display's overscan insets to the provided values. Note // that overscan values may not be negative or larger than a half of the // screen's size. Overscan cannot be changed on the internal monitor. // It's applied after <code>isPrimary</code> parameter. Insets? overscan; - + // If set, updates the display's rotation. // Legal values are [0, 90, 180, 270]. The rotation is set clockwise, // relative to the display's vertical position. // It's applied after <code>overscan</code> paramter. long? rotation; - + // If set, updates the display's logical bounds origin along x-axis. Applied // together with <code>boundsOriginY</code>, if <code>boundsOriginY</code> // is set. Note that, when updating the display origin, some constraints @@ -113,12 +114,12 @@ namespace systemInfo.display { // also invalid to set bounds origin values if <code>isPrimary</code> is // also set (as <code>isPrimary</code> parameter is applied first). long? boundsOriginX; - + // If set, updates the display's logical bounds origin along y-axis. // See documentation for <code>boundsOriginX</code> parameter. long? boundsOriginY; }; - + callback DisplayInfoCallback = void (DisplayUnitInfo[] displayInfo); callback SetDisplayUnitInfoCallback = void(); @@ -135,13 +136,13 @@ namespace systemInfo.display { // |info|. // |callback|: Empty function called when the function finishes. To find out // whether the function succeeded, $ref:runtime.lastError should be - // queried. + // queried. static void setDisplayProperties( DOMString id, DisplayProperties info, optional SetDisplayUnitInfoCallback callback); }; - + interface Events { // Fired when anything changes to the display configuration. static void onDisplayChanged(); diff --git a/chrome/common/extensions/api/system_private.json b/chrome/common/extensions/api/system_private.json index ec6cc53..7d95450 100644 --- a/chrome/common/extensions/api/system_private.json +++ b/chrome/common/extensions/api/system_private.json @@ -5,7 +5,7 @@ [ { "namespace": "systemPrivate", - "nodoc": true, + "description": "none", "types": [ { "id": "UpdateStatus", diff --git a/chrome/common/extensions/api/tab_capture.idl b/chrome/common/extensions/api/tab_capture.idl index dbd1d67..7e1d5c3 100644 --- a/chrome/common/extensions/api/tab_capture.idl +++ b/chrome/common/extensions/api/tab_capture.idl @@ -2,8 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// An API for tab media streams. - +// Use the <code>chrome.tabCapture</code> API to interact with tab media +// streams. namespace tabCapture { enum TabCaptureState { diff --git a/chrome/common/extensions/api/tabs.json b/chrome/common/extensions/api/tabs.json index 31f6ef2..3d2cf45 100644 --- a/chrome/common/extensions/api/tabs.json +++ b/chrome/common/extensions/api/tabs.json @@ -5,6 +5,7 @@ [ { "namespace": "tabs", + "description": "Use the <code>chrome.tabs</code> API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.", "types": [ { "id": "Tab", diff --git a/chrome/common/extensions/api/terminal_private.json b/chrome/common/extensions/api/terminal_private.json index 79817cc..07bbe2d 100644 --- a/chrome/common/extensions/api/terminal_private.json +++ b/chrome/common/extensions/api/terminal_private.json @@ -8,9 +8,8 @@ "compiler_options": { "implemented_in": "chrome/browser/extensions/api/terminal/terminal_private_api.h" }, - "nodoc": true, "platforms": ["chromeos"], - "types": [], + "description": "none", "functions": [ { "name": "openTerminalProcess", diff --git a/chrome/common/extensions/api/test.json b/chrome/common/extensions/api/test.json index e9a43d52..a06052d 100644 --- a/chrome/common/extensions/api/test.json +++ b/chrome/common/extensions/api/test.json @@ -5,8 +5,7 @@ [ { "namespace": "test", - "nodoc": true, - "types": [], + "description": "none", "functions": [ { "name": "getConfig", diff --git a/chrome/common/extensions/api/top_sites.json b/chrome/common/extensions/api/top_sites.json index e220447..3a8ece8 100644 --- a/chrome/common/extensions/api/top_sites.json +++ b/chrome/common/extensions/api/top_sites.json @@ -5,6 +5,7 @@ [ { "namespace": "topSites", + "description": "Use the <code>chrome.topSites</code> API to access the top sites that are displayed on the new tab page.", "types": [ { "id": "MostVisitedURL", diff --git a/chrome/common/extensions/api/tts.json b/chrome/common/extensions/api/tts.json index 49bd4b2..ae8771e 100644 --- a/chrome/common/extensions/api/tts.json +++ b/chrome/common/extensions/api/tts.json @@ -5,6 +5,7 @@ [ { "namespace": "tts", + "description": "Use the <code>chrome.tts</code> API to play synthesized text-to-speech (TTS). See also the related <a href='http://developer.chrome.com/extensions/ttsEngine.html'>ttsEngine</a> API, which allows an extension to implement a speech engine.", "types": [ { "id": "TtsEvent", diff --git a/chrome/common/extensions/api/tts_engine.json b/chrome/common/extensions/api/tts_engine.json index 4c6bb26..8dd72b1 100644 --- a/chrome/common/extensions/api/tts_engine.json +++ b/chrome/common/extensions/api/tts_engine.json @@ -5,6 +5,7 @@ [ { "namespace": "ttsEngine", + "description": "Use the <code>chrome.ttsEngine</code> API to implement a text-to-speech(TTS) engine using an extension. If your extension registers using this API, it will receive events containing an utterance to be spoken and other parameters when any extension or packaged app uses the <a href='tts.html'>tts</a> API to generate speech. Your extension can then use any available web technology to synthesize and output the speech, and send events back to the calling function to report the status.", "functions": [ { "name": "sendTtsEvent", diff --git a/chrome/common/extensions/api/types.json b/chrome/common/extensions/api/types.json index 7b80460..0ed8428 100644 --- a/chrome/common/extensions/api/types.json +++ b/chrome/common/extensions/api/types.json @@ -5,6 +5,7 @@ [ { "namespace": "types", + "description": "The <code>chrome.types</code> API contains type declarations for Chrome. Currently, this comprises only a prototype for giving other APIs access to manage Chrome browser settings. This prototype is used, for example, for $ref:proxy.settings.", "types": [ { "id": "ChromeSetting", diff --git a/chrome/common/extensions/api/usb.idl b/chrome/common/extensions/api/usb.idl index 068f34b..1b757b0 100644 --- a/chrome/common/extensions/api/usb.idl +++ b/chrome/common/extensions/api/usb.idl @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Use the <code>chrome.usb</code> API to interact with connected USB +// devices. This API provides access to USB operations from within the context +// of an app. Using this API, apps can function as drivers for hardware devices. namespace usb { // Direction, Recipient, RequestType, and TransferType all map to their diff --git a/chrome/common/extensions/api/wallpaper_private.json b/chrome/common/extensions/api/wallpaper_private.json index bb8ca78..40b870a 100644 --- a/chrome/common/extensions/api/wallpaper_private.json +++ b/chrome/common/extensions/api/wallpaper_private.json @@ -9,7 +9,7 @@ "implemented_in": "chrome/browser/chromeos/extensions/wallpaper_private_api.h" }, "platforms": ["chromeos"], - "nodoc": "true", + "description": "none", "functions": [ { "name": "getStrings", diff --git a/chrome/common/extensions/api/web_navigation.json b/chrome/common/extensions/api/web_navigation.json index 9fa1759..783ecdd 100644 --- a/chrome/common/extensions/api/web_navigation.json +++ b/chrome/common/extensions/api/web_navigation.json @@ -5,6 +5,7 @@ [ { "namespace": "webNavigation", + "description": "Use the <code>chrome.webNavigation</code> API to receive notifications about the status of navigation requests in-flight.", "types": [], "functions": [ { diff --git a/chrome/common/extensions/api/web_request.json b/chrome/common/extensions/api/web_request.json index 5a96a8c..6fd2b14 100644 --- a/chrome/common/extensions/api/web_request.json +++ b/chrome/common/extensions/api/web_request.json @@ -5,6 +5,7 @@ [ { "namespace": "webRequest", + "description": "Use the <code>chrome.webRequest</code> API to observe and analyze traffic and to intercept, block, or modify requests in-flight.", "properties": { "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": { "value": 20, diff --git a/chrome/common/extensions/api/web_request_internal.json b/chrome/common/extensions/api/web_request_internal.json index fbdc7fa..4c56b5d 100644 --- a/chrome/common/extensions/api/web_request_internal.json +++ b/chrome/common/extensions/api/web_request_internal.json @@ -5,7 +5,7 @@ [ { "namespace": "webRequestInternal", - "nodoc": true, + "description": "none", "functions": [ { "name": "addEventListener", diff --git a/chrome/common/extensions/api/web_socket_proxy_private.json b/chrome/common/extensions/api/web_socket_proxy_private.json index 4afa792..3666079 100644 --- a/chrome/common/extensions/api/web_socket_proxy_private.json +++ b/chrome/common/extensions/api/web_socket_proxy_private.json @@ -5,8 +5,7 @@ [ { "namespace": "webSocketProxyPrivate", - "nodoc": true, - "types": [], + "description": "none", "functions": [ { "name": "getPassportForTCP", diff --git a/chrome/common/extensions/api/webstore.json b/chrome/common/extensions/api/webstore.json index 2b72c0c..31cbd2d 100644 --- a/chrome/common/extensions/api/webstore.json +++ b/chrome/common/extensions/api/webstore.json @@ -5,6 +5,7 @@ [ { "namespace": "webstore", + "description": "Use the <code>chrome.webstore</code> API to initiate app and extension installations \"inline\" from your site.", "functions": [ { "name": "install", diff --git a/chrome/common/extensions/api/webstore_private.json b/chrome/common/extensions/api/webstore_private.json index 83fb48d..818e363 100644 --- a/chrome/common/extensions/api/webstore_private.json +++ b/chrome/common/extensions/api/webstore_private.json @@ -5,7 +5,7 @@ [ { "namespace":"webstorePrivate", - "nodoc": "true", + "description": "none", "functions": [ { "name": "install", diff --git a/chrome/common/extensions/api/webview.json b/chrome/common/extensions/api/webview.json index 0fe91eb..520d3fe 100644 --- a/chrome/common/extensions/api/webview.json +++ b/chrome/common/extensions/api/webview.json @@ -5,7 +5,7 @@ [ { "namespace": "webview", - "nodoc": true, + "description": "none", "functions": [ { "name": "executeScript", diff --git a/chrome/common/extensions/api/windows.json b/chrome/common/extensions/api/windows.json index f59ce95..eaa6760 100644 --- a/chrome/common/extensions/api/windows.json +++ b/chrome/common/extensions/api/windows.json @@ -5,6 +5,7 @@ [ { "namespace": "windows", + "description": "Use the <code>chrome.windows</code> API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser.", "compiler_options": { "implemented_in": "chrome/browser/extensions/api/tabs/tabs_api.h" }, diff --git a/chrome/common/extensions/docs/server2/api_data_source.py b/chrome/common/extensions/docs/server2/api_data_source.py index 7f3d32c..3fdd375 100644 --- a/chrome/common/extensions/docs/server2/api_data_source.py +++ b/chrome/common/extensions/docs/server2/api_data_source.py @@ -132,6 +132,7 @@ class _JSCModel(object): return {} return { 'name': self._namespace.name, + 'description': self._namespace.description, 'types': self._GenerateTypes(self._namespace.types.values()), 'functions': self._GenerateFunctions(self._namespace.functions), 'events': self._GenerateEvents(self._namespace.events), diff --git a/chrome/common/extensions/docs/server2/app.yaml b/chrome/common/extensions/docs/server2/app.yaml index f8c706ba7..537333d 100644 --- a/chrome/common/extensions/docs/server2/app.yaml +++ b/chrome/common/extensions/docs/server2/app.yaml @@ -1,5 +1,5 @@ application: chrome-apps-doc -version: 2-7-2 +version: 2-8-0 runtime: python27 api_version: 1 threadsafe: false diff --git a/chrome/common/extensions/docs/server2/cron.yaml b/chrome/common/extensions/docs/server2/cron.yaml index 9529324..f67361a 100644 --- a/chrome/common/extensions/docs/server2/cron.yaml +++ b/chrome/common/extensions/docs/server2/cron.yaml @@ -2,19 +2,19 @@ cron: - description: Load everything for trunk. url: /_cron/trunk schedule: every 5 minutes - target: 2-7-2 + target: 2-8-0 - description: Load everything for dev. url: /_cron/dev schedule: every 5 minutes - target: 2-7-2 + target: 2-8-0 - description: Load everything for beta. url: /_cron/beta schedule: every 5 minutes - target: 2-7-2 + target: 2-8-0 - description: Load everything for stable. url: /_cron/stable schedule: every 5 minutes - target: 2-7-2 + target: 2-8-0 diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json b/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json index b9dfa6b..9d5993a 100644 --- a/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json +++ b/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json @@ -94,6 +94,7 @@ ], "properties": [], "name": "tester", + "description": "a test api", "types": [ { "properties": [ diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json b/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json index 6e07fe1..d9fffae 100644 --- a/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json +++ b/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json @@ -1,6 +1,7 @@ [ { "namespace": "ref_test", + "description": "An API for testing ref's", "types": [ { "id": "type1", diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json b/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json index ea39b62..5f4fbf5 100644 --- a/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json +++ b/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json @@ -1,6 +1,7 @@ [ { "namespace": "tester", + "description": "a test api", "types": [ { "id": "TypeA", diff --git a/chrome/common/extensions/docs/templates/intros/dial.html b/chrome/common/extensions/docs/templates/intros/dial.html new file mode 100644 index 0000000..9d84882 --- /dev/null +++ b/chrome/common/extensions/docs/templates/intros/dial.html @@ -0,0 +1,30 @@ +<p>The <code>chrome.dial</code> API is backed by a service that multicasts +discovery requests on the local network to discover DIAL-capable devices and +maintains a list of devices that have responded. Adding an onDeviceList +listener causes the service to periodically issue discovery requests to maintain +the device list. (No polling is done when there are no onDeviceList listeners.) +</p> + +<p>The onDeviceList event is fired when discovery respnses are received and in +other circumstances; see the documentation for onDeviceList.</p> + +<p>The client can request that network discovery can be done immediately by +invoking discoverNow() which is useful for presenting the user with an +updated list of devices.</p> + +<p>On-demand use (updates when discoverNow() is called): +<pre> +chrome.dial.onDeviceList.addListener(function (list) { updateMenu(list); }); +chrome.dial.discoverNow(); +</pre> +(Remember to remove the listener when the menu closes.)</p> + +<p>Background use (updates only when periodic polling happens):</p> + +<pre> +var myList; +chrome.dial.onDeviceList.addListener(function (list) { myList = list; }); +</pre> + +<p>These can be combined to poll for devices to prime the device menu, then +refresh the menu when it is displayed.</p> diff --git a/tools/json_schema_compiler/dart_test/dictionaries.idl b/tools/json_schema_compiler/dart_test/dictionaries.idl index 4b26684..1eb9e25 100644 --- a/tools/json_schema_compiler/dart_test/dictionaries.idl +++ b/tools/json_schema_compiler/dart_test/dictionaries.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// This comment is for the dictionaries namespace. namespace dictionaries { // Documentation for ComplexType. dictionary InnerType { diff --git a/tools/json_schema_compiler/dart_test/empty_namespace.idl b/tools/json_schema_compiler/dart_test/empty_namespace.idl index 5a5ea03..824de2d 100644 --- a/tools/json_schema_compiler/dart_test/empty_namespace.idl +++ b/tools/json_schema_compiler/dart_test/empty_namespace.idl @@ -2,5 +2,6 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// An empty comment is required for an empty namespace. namespace empty_namespace { }; diff --git a/tools/json_schema_compiler/dart_test/empty_type.idl b/tools/json_schema_compiler/dart_test/empty_type.idl index af5de84..9d7de6f 100644 --- a/tools/json_schema_compiler/dart_test/empty_type.idl +++ b/tools/json_schema_compiler/dart_test/empty_type.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Namespace-level comment for EmptyType. namespace empty_type { // Documentation for EmptyType. dictionary EmptyType { diff --git a/tools/json_schema_compiler/dart_test/enums.idl b/tools/json_schema_compiler/dart_test/enums.idl index 18ea85a..1c82d00 100644 --- a/tools/json_schema_compiler/dart_test/enums.idl +++ b/tools/json_schema_compiler/dart_test/enums.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// A comment for the enums namespace. namespace enums { // A basic enumeration. enum Enum1 { a, b }; diff --git a/tools/json_schema_compiler/dart_test/events.idl b/tools/json_schema_compiler/dart_test/events.idl index 54c711a..f1fb4b6 100644 --- a/tools/json_schema_compiler/dart_test/events.idl +++ b/tools/json_schema_compiler/dart_test/events.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// This comment is for the events namespace. namespace events { dictionary EventArgumentElement { DOMString elementStringArg; diff --git a/tools/json_schema_compiler/dart_test/functions.idl b/tools/json_schema_compiler/dart_test/functions.idl index e2283c6..e303d0d 100644 --- a/tools/json_schema_compiler/dart_test/functions.idl +++ b/tools/json_schema_compiler/dart_test/functions.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// A comment for the functions namespace. namespace functions { callback SimpleCallback = void (); diff --git a/tools/json_schema_compiler/dart_test/operatable_type.idl b/tools/json_schema_compiler/dart_test/operatable_type.idl index 74ce534..9c5f53c 100644 --- a/tools/json_schema_compiler/dart_test/operatable_type.idl +++ b/tools/json_schema_compiler/dart_test/operatable_type.idl @@ -2,6 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Top-level namespace-comment for operatableType namespace operatable_type { dictionary DictType { int x; @@ -28,4 +29,4 @@ namespace operatable_type { // Function taking dict type. static void dictArgFunc(DictType d); }; -};
\ No newline at end of file +}; diff --git a/tools/json_schema_compiler/dart_test/tags.idl b/tools/json_schema_compiler/dart_test/tags.idl index f4ddff4..7a029cd 100644 --- a/tools/json_schema_compiler/dart_test/tags.idl +++ b/tools/json_schema_compiler/dart_test/tags.idl @@ -2,30 +2,31 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// A comment describing tags. namespace tags { // This dictionary has the property [inline_doc]. [inline_doc] dictionary InlineDoc { }; - + // This dictionary has the property [nodoc]. [nodoc] dictionary Nodoc { }; - + // This dictionary has the property [nocompile]. [nocompile] dictionary Nocompile { }; - + // This dictionary has no tags on the dictionary itself. dictionary PlainDict { // This int has the property [inline_doc]. [inline_doc] int inline_doc; - + // This String has the property [nodoc]. [nodoc] String nodoc; - + // This double has the property [nocompile]. [nocompile] double nocompile; - + // This object has the property [instanceOf=fileEntry]. [instanceOf=fileEntry] object instance_of_tag; }; diff --git a/tools/json_schema_compiler/idl_schema.py b/tools/json_schema_compiler/idl_schema.py index 519ae56..8197f31 100644 --- a/tools/json_schema_compiler/idl_schema.py +++ b/tools/json_schema_compiler/idl_schema.py @@ -309,7 +309,7 @@ class Namespace(object): dictionary that the JSON schema compiler expects to see. ''' - def __init__(self, namespace_node, nodoc=False, internal=False): + def __init__(self, namespace_node, description, nodoc=False, internal=False): self.namespace = namespace_node self.nodoc = nodoc self.internal = internal @@ -317,6 +317,7 @@ class Namespace(object): self.functions = [] self.types = [] self.callbacks = OrderedDict() + self.description = description def process(self): for node in self.namespace.children: @@ -334,6 +335,7 @@ class Namespace(object): else: sys.exit('Did not process %s %s' % (node.cls, node)) return {'namespace': self.namespace.GetName(), + 'description': self.description, 'nodoc': self.nodoc, 'types': self.types, 'functions': self.functions, @@ -361,16 +363,20 @@ class IDLSchema(object): namespaces = [] nodoc = False internal = False + description = None for node in self.idl: if node.cls == 'Namespace': - namespace = Namespace(node, nodoc, internal) + if not description: + raise ValueError('%s must have a namespace-level comment. This will ' + 'appear on the API summary page.' % node.GetName()) + namespace = Namespace(node, description, nodoc, internal) namespaces.append(namespace.process()) nodoc = False internal = False elif node.cls == 'Copyright': continue elif node.cls == 'Comment': - continue + description = node.GetName() elif node.cls == 'ExtAttribute': if node.name == 'nodoc': nodoc = bool(node.value) diff --git a/tools/json_schema_compiler/json_schema_test.py b/tools/json_schema_compiler/json_schema_test.py index ffba653..11ba61e 100755 --- a/tools/json_schema_compiler/json_schema_test.py +++ b/tools/json_schema_compiler/json_schema_test.py @@ -12,12 +12,14 @@ class JsonSchemaUnittest(unittest.TestCase): compiled = [ { "namespace": "compile", + "description": "The compile API.", "functions": [], "types": {} }, { "namespace": "functions", + "description": "The functions API.", "functions": [ { "id": "two" @@ -34,6 +36,7 @@ class JsonSchemaUnittest(unittest.TestCase): { "namespace": "types", + "description": "The types API.", "functions": [ { "id": "one" } ], @@ -49,6 +52,7 @@ class JsonSchemaUnittest(unittest.TestCase): { "namespace": "nested", + "description": "The nested API.", "properties": { "sync": { "functions": [ diff --git a/tools/json_schema_compiler/model.py b/tools/json_schema_compiler/model.py index d6b6efc..d49c18f 100644 --- a/tools/json_schema_compiler/model.py +++ b/tools/json_schema_compiler/model.py @@ -39,6 +39,7 @@ class Namespace(object): Properties: - |name| the name of the namespace + - |description| the description of the namespace - |unix_name| the unix_name of the namespace - |source_file| the file that contained the namespace definition - |source_file_dir| the directory component of |source_file| @@ -54,6 +55,10 @@ class Namespace(object): """ def __init__(self, json, source_file, include_compiler_options=False): self.name = json['namespace'] + if 'description' not in json: + raise ValueError('%s must have a "description" field. This will appear ' + 'on the API summary page.' % self.name) + self.description = json.get('description', None) self.unix_name = UnixName(self.name) self.source_file = source_file self.source_file_dir, self.source_file_filename = os.path.split(source_file) diff --git a/tools/json_schema_compiler/test/additional_properties.json b/tools/json_schema_compiler/test/additional_properties.json index 0b800d9..a40c479 100644 --- a/tools/json_schema_compiler/test/additional_properties.json +++ b/tools/json_schema_compiler/test/additional_properties.json @@ -1,6 +1,7 @@ [ { "namespace": "additionalProperties", + "description": "The additionalProperties API.", "types": [ { "id": "AdditionalPropertiesType", diff --git a/tools/json_schema_compiler/test/any.json b/tools/json_schema_compiler/test/any.json index 55da4a6..d836a04 100644 --- a/tools/json_schema_compiler/test/any.json +++ b/tools/json_schema_compiler/test/any.json @@ -1,6 +1,7 @@ [ { "namespace": "any", + "description": "The any API.", "types": [ { "id": "AnyType", diff --git a/tools/json_schema_compiler/test/arrays.json b/tools/json_schema_compiler/test/arrays.json index a0edd54..690d5cb 100644 --- a/tools/json_schema_compiler/test/arrays.json +++ b/tools/json_schema_compiler/test/arrays.json @@ -1,6 +1,7 @@ [ { "namespace": "arrays", + "description": "The arrays API.", "types": [ { "id": "EnumArrayType", diff --git a/tools/json_schema_compiler/test/browser_action.json b/tools/json_schema_compiler/test/browser_action.json index 6288fab..934d56d 100644 --- a/tools/json_schema_compiler/test/browser_action.json +++ b/tools/json_schema_compiler/test/browser_action.json @@ -5,6 +5,7 @@ [ { "namespace": "browserAction", + "description": "The browserAction API.", "dependencies": [ "tabs" ], "types": [ { diff --git a/tools/json_schema_compiler/test/callbacks.json b/tools/json_schema_compiler/test/callbacks.json index 06455b9..2f86c26 100644 --- a/tools/json_schema_compiler/test/callbacks.json +++ b/tools/json_schema_compiler/test/callbacks.json @@ -1,6 +1,7 @@ [ { "namespace": "callbacks", + "description": "The callbacks API.", "types": [], "functions": [ { diff --git a/tools/json_schema_compiler/test/choices.json b/tools/json_schema_compiler/test/choices.json index 24683c4..29afb47 100644 --- a/tools/json_schema_compiler/test/choices.json +++ b/tools/json_schema_compiler/test/choices.json @@ -1,6 +1,7 @@ [ { "namespace": "choices", + "description": "The choices API.", "types": [ { "id": "ChoiceType", diff --git a/tools/json_schema_compiler/test/content_settings.json b/tools/json_schema_compiler/test/content_settings.json index 2d6e803..6fac436 100644 --- a/tools/json_schema_compiler/test/content_settings.json +++ b/tools/json_schema_compiler/test/content_settings.json @@ -5,6 +5,7 @@ [ { "namespace": "contentSettings", + "description": "The contentSettings API.", "types": [ { "id": "ResourceIdentifier", diff --git a/tools/json_schema_compiler/test/crossref.json b/tools/json_schema_compiler/test/crossref.json index 9d3f905..a1e994b 100644 --- a/tools/json_schema_compiler/test/crossref.json +++ b/tools/json_schema_compiler/test/crossref.json @@ -1,6 +1,7 @@ [ { "namespace": "crossref", + "description": "The crossref API.", "dependencies": ["simple_api"], "types": [ { diff --git a/tools/json_schema_compiler/test/dependency_tester.json b/tools/json_schema_compiler/test/dependency_tester.json index 15ff4ac..4845136 100644 --- a/tools/json_schema_compiler/test/dependency_tester.json +++ b/tools/json_schema_compiler/test/dependency_tester.json @@ -5,6 +5,7 @@ [ { "namespace": "dependencyTester", + "description": "An API for testing dependencies.", "dependencies": [ "browserAction", "fontSettings" ], "types": [], "functions": [ diff --git a/tools/json_schema_compiler/test/enums.json b/tools/json_schema_compiler/test/enums.json index 6769b19..19229b0 100644 --- a/tools/json_schema_compiler/test/enums.json +++ b/tools/json_schema_compiler/test/enums.json @@ -1,6 +1,7 @@ [ { "namespace": "enums", + "description": "The enums API.", "types": [ { "id": "Enumeration", diff --git a/tools/json_schema_compiler/test/font_settings.json b/tools/json_schema_compiler/test/font_settings.json index 0326aca..01c49f7 100644 --- a/tools/json_schema_compiler/test/font_settings.json +++ b/tools/json_schema_compiler/test/font_settings.json @@ -5,6 +5,7 @@ [ { "namespace": "fontSettings", + "description": "The fontSettings API.", "types": [ { "id": "FontName", diff --git a/tools/json_schema_compiler/test/forbidden.json b/tools/json_schema_compiler/test/forbidden.json index c7978aa..841b0e1 100644 --- a/tools/json_schema_compiler/test/forbidden.json +++ b/tools/json_schema_compiler/test/forbidden.json @@ -1,6 +1,7 @@ [ { "namespace": "forbidden", + "description": "The forbidden API... Careful.", "types": [], "functions": [ { diff --git a/tools/json_schema_compiler/test/functions_as_parameters.json b/tools/json_schema_compiler/test/functions_as_parameters.json index cdc47ff..b948616 100644 --- a/tools/json_schema_compiler/test/functions_as_parameters.json +++ b/tools/json_schema_compiler/test/functions_as_parameters.json @@ -1,6 +1,7 @@ [ { "namespace": "functions_as_parameters", + "description": "The functionsAsParameters API", "types": [ { "id": "FunctionType", diff --git a/tools/json_schema_compiler/test/functions_on_types.json b/tools/json_schema_compiler/test/functions_on_types.json index e8c8220..a20a75f 100644 --- a/tools/json_schema_compiler/test/functions_on_types.json +++ b/tools/json_schema_compiler/test/functions_on_types.json @@ -1,6 +1,7 @@ [ { "namespace": "functionsOnTypes", + "description": "The functionsOnTypes API.", "types": [ { "id": "StorageArea", diff --git a/tools/json_schema_compiler/test/idl_reserved_words.idl b/tools/json_schema_compiler/test/idl_reserved_words.idl index 61ddabd..411973e 100644 --- a/tools/json_schema_compiler/test/idl_reserved_words.idl +++ b/tools/json_schema_compiler/test/idl_reserved_words.idl @@ -2,6 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. +// Tests 'reserved words' in various places in IDL. + namespace reserved_words { enum Foo { _float, _DOMString }; diff --git a/tools/json_schema_compiler/test/json_schema_test.json b/tools/json_schema_compiler/test/json_schema_test.json index 0ac9131..b3b24e9 100644 --- a/tools/json_schema_compiler/test/json_schema_test.json +++ b/tools/json_schema_compiler/test/json_schema_test.json @@ -1,12 +1,14 @@ [ { "namespace": "compile", + "description": "The compile API.", "functions": [], "types": {} }, { "namespace": "nocompile", + "description": "The nocompile API.", "nocompile": true, "functions": [], "types": {} @@ -14,6 +16,7 @@ { "namespace": "functions", + "description": "The functions API.", "functions": [ { "id": "one", @@ -38,6 +41,7 @@ { "namespace": "types", + "description": "The types API.", "functions": [ { "id": "one" } ], @@ -61,6 +65,7 @@ { "namespace": "nested", + "description": "The nested API.", "properties": { "sync": { "functions": [ diff --git a/tools/json_schema_compiler/test/objects.json b/tools/json_schema_compiler/test/objects.json index 00a7f53..e76e229 100644 --- a/tools/json_schema_compiler/test/objects.json +++ b/tools/json_schema_compiler/test/objects.json @@ -1,6 +1,7 @@ [ { "namespace": "objects", + "description": "The objects API.", "types": [], "functions": [ { diff --git a/tools/json_schema_compiler/test/permissions.json b/tools/json_schema_compiler/test/permissions.json index 1f4cb9f..df97441 100644 --- a/tools/json_schema_compiler/test/permissions.json +++ b/tools/json_schema_compiler/test/permissions.json @@ -1,6 +1,7 @@ [ { "namespace": "permissions", + "description": "A test API for the json_schema_compiler.", "types": [ { "id": "Permissions", diff --git a/tools/json_schema_compiler/test/simple_api.json b/tools/json_schema_compiler/test/simple_api.json index 82d77b8..9ab5403 100644 --- a/tools/json_schema_compiler/test/simple_api.json +++ b/tools/json_schema_compiler/test/simple_api.json @@ -1,6 +1,7 @@ [ { "namespace": "simple_api", + "description": "This is a simple API.", "types": [ { "id": "TestType", diff --git a/tools/json_schema_compiler/test/tabs.json b/tools/json_schema_compiler/test/tabs.json index af0910a..d7271e6 100644 --- a/tools/json_schema_compiler/test/tabs.json +++ b/tools/json_schema_compiler/test/tabs.json @@ -1,6 +1,7 @@ [ { "namespace": "tabs", + "description": "The tabs API.", "types": [ { "id": "Tab", diff --git a/tools/json_schema_compiler/test/windows.json b/tools/json_schema_compiler/test/windows.json index f6062d4..ae90084 100644 --- a/tools/json_schema_compiler/test/windows.json +++ b/tools/json_schema_compiler/test/windows.json @@ -1,6 +1,7 @@ [ { "namespace": "windows", + "description": "The windows API.", "types": [ { "id": "Window", |