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

Side by Side Diff: chrome/common/extensions/api/debugger.json

Issue 240283011: DevTools: Clarify chrome.debugger API documentation (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 6 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 [ 5 [
6 { 6 {
7 "namespace": "debugger", 7 "namespace": "debugger",
8 "description": "The <code>chrome.debugger</code> API serves as an alternate transport for Chrome's <a href='http://code.google.com/chrome/devtools/docs/remo te-debugging.html'>remote debugging protocol</a>. Use <code>chrome.debugger</cod e> to attach to one or more tabs to instrument network interaction, debug JavaSc ript, 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 callb acks.", 8 "description": "The <code>chrome.debugger</code> API serves as an alternate transport for Chrome's <a href='http://code.google.com/chrome/devtools/docs/remo te-debugging.html'>remote debugging protocol</a>. Use <code>chrome.debugger</cod e> to attach to one or more tabs to instrument network interaction, debug JavaSc ript, 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 callb acks.",
9 "types": [ 9 "types": [
10 { 10 {
(...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after
106 { 106 {
107 "type": "function", 107 "type": "function",
108 "name": "callback", 108 "name": "callback",
109 "optional": true, 109 "optional": true,
110 "parameters": [ 110 "parameters": [
111 { 111 {
112 "type": "object", 112 "type": "object",
113 "name": "result", 113 "name": "result",
114 "optional": true, 114 "optional": true,
115 "additionalProperties": { "type": "any" }, 115 "additionalProperties": { "type": "any" },
116 "description": "JSON object with the response. Structure of the response varies depending on the method and is defined by the remote debugging p rotocol." 116 "description": "JSON object with the response. Structure of the response varies depending on the method name and is defined by the 'returns' att ribute of the command description in the remote debugging protocol."
117 } 117 }
118 ], 118 ],
119 "description": "Response body. If an error occurs while posting the message, the callback will be called with no arguments and $(ref:runtime.lastErr or) will be set to the error message." 119 "description": "Response body. If an error occurs while posting the message, the callback will be called with no arguments and $(ref:runtime.lastErr or) will be set to the error message."
120 } 120 }
121 ] 121 ]
122 }, 122 },
123 { 123 {
124 "name": "getTargets", 124 "name": "getTargets",
125 "type": "function", 125 "type": "function",
126 "description": "Returns the list of available debug targets.", 126 "description": "Returns the list of available debug targets.",
(...skipping 27 matching lines...) Expand all
154 { 154 {
155 "type": "string", 155 "type": "string",
156 "name": "method", 156 "name": "method",
157 "description": "Method name. Should be one of the notifications defi ned by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging .html'>remote debugging protocol</a>." 157 "description": "Method name. Should be one of the notifications defi ned by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging .html'>remote debugging protocol</a>."
158 }, 158 },
159 { 159 {
160 "type": "object", 160 "type": "object",
161 "name": "params", 161 "name": "params",
162 "optional": true, 162 "optional": true,
163 "additionalProperties": { "type": "any" }, 163 "additionalProperties": { "type": "any" },
164 "description": "JSON object with the response. Structure of the resp onse varies depending on the method and is defined by the remote debugging proto col." 164 "description": "JSON object with the parameters. Structure of the pa rameters varies depending on the method name and is defined by the 'parameters' attribute of the event description in the remote debugging protocol."
165 } 165 }
166 ] 166 ]
167 }, 167 },
168 { 168 {
169 "name": "onDetach", 169 "name": "onDetach",
170 "type": "function", 170 "type": "function",
171 "description": "Fired when browser terminates debugging session for the tab. This happens when either the tab is being closed or Chrome DevTools is bein g invoked for the attached tab.", 171 "description": "Fired when browser terminates debugging session for the tab. This happens when either the tab is being closed or Chrome DevTools is bein g invoked for the attached tab.",
172 "parameters": [ 172 "parameters": [
173 { 173 {
174 "$ref": "Debuggee", 174 "$ref": "Debuggee",
175 "name": "source", 175 "name": "source",
176 "description": "The debuggee that was detached." 176 "description": "The debuggee that was detached."
177 }, 177 },
178 { 178 {
179 "type": "string", 179 "type": "string",
180 "name": "reason", 180 "name": "reason",
181 "description": "Connection termination reason.", 181 "description": "Connection termination reason.",
182 "enum": [ "target_closed", "canceled_by_user", "replaced_with_devtoo ls" ] 182 "enum": [ "target_closed", "canceled_by_user", "replaced_with_devtoo ls" ]
183 } 183 }
184 ] 184 ]
185 } 185 }
186 ] 186 ]
187 } 187 }
188 ] 188 ]
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698