summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDHNishi@gmail.com <DHNishi@gmail.com@0039d316-1c4b-4281-b951-d872f2087c98>2013-11-14 21:20:08 +0000
committerDHNishi@gmail.com <DHNishi@gmail.com@0039d316-1c4b-4281-b951-d872f2087c98>2013-11-14 21:20:08 +0000
commit2438710bad0b763ff380434f9c11cda0ff697ad4 (patch)
tree867ab5fc101f5a2cc4b32d53f9b573a9811b8f17
parent1cdbe75eda4805d9928aa6e82f7c0311f427f5f6 (diff)
downloadchromium_src-2438710bad0b763ff380434f9c11cda0ff697ad4.zip
chromium_src-2438710bad0b763ff380434f9c11cda0ff697ad4.tar.gz
chromium_src-2438710bad0b763ff380434f9c11cda0ff697ad4.tar.bz2
Changing deprecated with nodoc over to using deprecated annotation.
NOTRY=true BUG=239196 Review URL: https://codereview.chromium.org/47143003 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@235234 0039d316-1c4b-4281-b951-d872f2087c98
-rw-r--r--chrome/common/extensions/api/extension.json18
-rw-r--r--chrome/common/extensions/api/management.json2
-rw-r--r--chrome/common/extensions/api/runtime.json2
-rw-r--r--chrome/common/extensions/api/tabs.json30
-rw-r--r--chrome/common/extensions/docs/templates/private/function.html2
5 files changed, 27 insertions, 27 deletions
diff --git a/chrome/common/extensions/api/extension.json b/chrome/common/extensions/api/extension.json
index f2ba094..e12c87e 100644
--- a/chrome/common/extensions/api/extension.json
+++ b/chrome/common/extensions/api/extension.json
@@ -28,10 +28,10 @@
{
"name": "sendRequest",
"nocompile": true,
- "nodoc": true,
+ "deprecated": "Please use $ref:runtime.sendMessage.",
"type": "function",
"allowAmbiguousOptionalArguments": true,
- "description": "Deprecated: Please use sendMessage.",
+ "description": "Sends a single request to other listeners within the extension. Similar to $ref:runtime.connect, but only sends a single request with an optional response. The $ref:onRequest event is fired in each page of the extension.",
"parameters": [
{"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."},
{ "type": "any", "name": "request" },
@@ -119,10 +119,10 @@
{
"name": "getExtensionTabs",
"nocompile": true,
- "nodoc": true,
+ "deprecated": "Please use $ref:getViews <code>{type: \"tab\"}</code>.",
"type": "function",
"maximumManifestVersion": 1,
- "description": "Deprecated. Please use getViews({type: 'TAB'}). Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If windowId is specified, returns only the 'window' objects of tabs attached to the specified window.",
+ "description": "Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If <code>windowId</code> is specified, returns only the 'window' objects of tabs attached to the specified window.",
"parameters": [
{"type": "integer", "name": "windowId", "optional": true}
],
@@ -187,12 +187,12 @@
"events": [
{
"name": "onRequest",
- "nodoc": true,
+ "deprecated": "Please use $ref:runtime.onMessage.",
"type": "function",
"options": {
"unmanaged": true
},
- "description": "Deprecated: please use onMessage.",
+ "description": "Fired when a request is sent from either an extension process or a content script.",
"parameters": [
{"name": "request", "type": "any", "optional": true, "description": "The request sent by the calling script."},
{"name": "sender", "$ref": "runtime.MessageSender" },
@@ -201,12 +201,12 @@
},
{
"name": "onRequestExternal",
- "nodoc": true,
+ "deprecated": "Please use $ref:runtime.onMessageExternal.",
"type": "function",
"options": {
"unmanaged": true
},
- "description": "Deprecated: please use onMessageExternal.",
+ "description": "Fired when a request is sent from another extension.",
"parameters": [
{"name": "request", "type": "any", "optional": true, "description": "The request sent by the calling script."},
{"name": "sender", "$ref": "runtime.MessageSender" },
@@ -215,4 +215,4 @@
}
]
}
-]
+] \ No newline at end of file
diff --git a/chrome/common/extensions/api/management.json b/chrome/common/extensions/api/management.json
index b8b58b4..f2a35d9 100644
--- a/chrome/common/extensions/api/management.json
+++ b/chrome/common/extensions/api/management.json
@@ -58,7 +58,7 @@
"isApp": {
"description": "True if this is an app.",
"type": "boolean",
- "nodoc": true
+ "deprecated": "Please use $ref:ExtensionInfo.type."
},
"type": {
"description": "The type of this extension, app, or theme.",
diff --git a/chrome/common/extensions/api/runtime.json b/chrome/common/extensions/api/runtime.json
index 82ff479..e67323a 100644
--- a/chrome/common/extensions/api/runtime.json
+++ b/chrome/common/extensions/api/runtime.json
@@ -393,7 +393,7 @@
"name": "onBrowserUpdateAvailable",
"type": "function",
"description": "Fired when a Chrome update is available, but isn't installed immediately because a browser restart is required.",
- "nodoc": true,
+ "deprecated": "Please use $ref:onRestartRequired.",
"parameters": []
},
{
diff --git a/chrome/common/extensions/api/tabs.json b/chrome/common/extensions/api/tabs.json
index 4b4077d6..0d2d60c 100644
--- a/chrome/common/extensions/api/tabs.json
+++ b/chrome/common/extensions/api/tabs.json
@@ -16,7 +16,7 @@
"index": {"type": "integer", "minimum": -1, "description": "The zero-based index of the tab within its window."},
"windowId": {"type": "integer", "minimum": 0, "description": "The ID of the window the tab is contained within."},
"openerTabId": {"type": "integer", "minimum": 0, "optional": true, "description": "The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists."},
- "selected": {"type": "boolean", "description": "Whether the tab is selected.", "nodoc": true},
+ "selected": {"type": "boolean", "description": "Whether the tab is selected.", "deprecated": "Please use $ref:Tab.highlighted."},
"highlighted": {"type": "boolean", "description": "Whether the tab is highlighted."},
"active": {"type": "boolean", "description": "Whether the tab is active in its window. (Does not necessarily mean the window is focused.)"},
"pinned": {"type": "boolean", "description": "Whether the tab is pinned."},
@@ -112,10 +112,10 @@
},
{
"name": "sendRequest",
- "nodoc": true,
+ "deprecated": "Please use $ref:runtime.sendMessage.",
"nocompile": true,
"type": "function",
- "description": "Deprecated: Please use sendMessage.",
+ "description": "Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The $ref:extension.onRequest event is fired in each content script running in the specified tab for the current extension.",
"parameters": [
{
"type": "integer",
@@ -171,9 +171,9 @@
},
{
"name": "getSelected",
- "nodoc": true,
+ "deprecated": "Please use $ref:query <code>{active: true}</code>.",
"type": "function",
- "description": "Deprecated. Please use query({'active': true}). Gets the tab that is selected in the specified window.",
+ "description": "Gets the tab that is selected in the specified window.",
"parameters": [
{
"type": "integer",
@@ -194,8 +194,8 @@
{
"name": "getAllInWindow",
"type": "function",
- "nodoc": true,
- "description": "Deprecated. Please use query({'windowId': windowId}). Gets details about all tabs in the specified window.",
+ "deprecated": "Please use $ref:query <code>{windowId: windowId}</code>.",
+ "description": "Gets details about all tabs in the specified window.",
"parameters": [
{
"type": "integer",
@@ -245,7 +245,7 @@
"description": "Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see $ref:windows.update). Defaults to <var>true</var>."
},
"selected": {
- "nodoc": true,
+ "deprecated": "Please use <em>active</em>.",
"type": "boolean",
"optional": true,
"description": "Whether the tab should become the selected tab in the window. Defaults to <var>true</var>"
@@ -457,7 +457,7 @@
"description": "Adds or removes the tab from the current selection."
},
"selected": {
- "nodoc": true,
+ "deprecated": "Please use <em>highlighted</em>.",
"type": "boolean",
"optional": true,
"description": "Whether the tab should be selected."
@@ -760,9 +760,9 @@
},
{
"name": "onSelectionChanged",
- "nodoc": true,
+ "deprecated": "Please use $ref:onActivated.",
"type": "function",
- "description": "Deprecated. Please use onActivated.",
+ "description": "Fires when the selected tab in a window changes.",
"parameters": [
{
"type": "integer",
@@ -785,9 +785,9 @@
},
{
"name": "onActiveChanged",
- "nodoc": true,
+ "deprecated": "Please use $ref:onActivated.",
"type": "function",
- "description": "Deprecated. Please use onActivated.",
+ "description": "Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to $ref:onUpdated events to be notified when a URL is set.",
"parameters": [
{
"type": "integer",
@@ -833,9 +833,9 @@
},
{
"name": "onHighlightChanged",
+ "deprecated": "Please use $ref:onHighlighted.",
"type": "function",
- "nodoc": true,
- "description": "Deprecated. Please use onHighlighted.",
+ "description": "Fired when the highlighted or selected tabs in a window changes.",
"parameters": [
{
"type": "object",
diff --git a/chrome/common/extensions/docs/templates/private/function.html b/chrome/common/extensions/docs/templates/private/function.html
index 28b273d..472ad0e 100644
--- a/chrome/common/extensions/docs/templates/private/function.html
+++ b/chrome/common/extensions/docs/templates/private/function.html
@@ -2,6 +2,6 @@
<h4 id="{{?id}}{{id}}{{:}}{{?parentId}}{{parentId}}-{{name}}{{/}}{{/}}">
{{name}}
</h4>
- {{+partials.warning_deprecated function:@}}
+ {{+partials.warning_deprecated item:@}}
{{+partials.function_details function:@ parentName:parentName api:api}}
</div>