fixes for issue #51 in devtools-docs

chrome/common/extensions/api/devtools/inspected_window.json

 // Copyright (c) 2012 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.
 
 [
   {
     "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": [
@@ skipping 78 matching lines @@
         "name": "eval",
         "type": "function",
         "description": "Evaluates a JavaScript expression in the context of the main frame of the inspected page. The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown.",
         "parameters": [
           {
             "name": "expression",
             "type": "string",
             "description": "An expression to evaluate."
           },
           {
+            "name": "options",
+            "type": "object",
+            "optional": true,
+            "description": "The options parameter can contain one or more of three options.",

[caseq, 2014/05/15 14:31:34]

nit: can we drop the exact options count? I bet we'll forget to update it when
we add more :)

[mem, 2014/05/15 20:19:03]

Done.

+            "properties": {
+              "frameURL": {
+                "type": "string",
+                "optional": true,
+                "description": "Specify a frame other than the inspected window's top frame."

[caseq, 2014/05/15 14:31:34]

If specified, the expression is evaluated on the iframe whose url matches the
one specified. By default, the expression is evaluated in the top frame of the
inspected page.

[mem, 2014/05/15 20:19:03]

Done.

+              },
+              "useContentScriptContext": {
+                "type": "boolean",
+                "optional": true,
+                "description": "Evaluate the expression in the JS context with the same Web Origin as this extension. If this extension has no content script, the result will be a console.warn message."

[caseq, 2014/05/15 14:31:34]

"Evaluate the expression in the context of the content script of calling
extension, provided such content script is already injected into the inspected
page. If not, the expression will not be evaluated and the callback will be
invoked with the exception parameter set to object that has <code>isError</code>
field set to true and <code>code</code> field set to <code>E_NOTFOUND</code>.

I think whenever we talk of the errors, we should make emphasis the API aspect
(i.e. describe under what conditions and in what ways we indicate errors to the
extension). The console.warn is somewhat less important to document, since it's
somewhat self-evident.

The error handing in the particular case of eval is even more confusing, since
we may report either DevTools-side error (such as the one described above), or a
JavaScript exception that occurred while actually evaluating the expression. I
think we may want to describe the difference between two somewhere in the eval()
usage comments or in the description of callback (in both cases, the value
parameter of the callback will be <code>undefined</code> and there will be a
non-null exception parameter that will have <code>isError</code> set to true and
<code>code</code> set to error code in the former case and
<code>isException</code> set to true and value set to the string value of thrown
exception in the latter case).

[mem, 2014/05/15 20:19:03]

Done.

+              },
+              "contextSecurityOrigin": {
+                "type": "string",
+                "optional": true,
+                "description": "Evaluate the expression in the JS environment with a WebOrigin matching the given string. If given, the contextSecurityOrigin overrides the 'true' setting on userContentScriptContext."

[caseq, 2014/05/15 14:31:34]

... in the context of a content script of an extension that matches the
specified origin.

The latter statement is not true according to
https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit...

[mem, 2014/05/15 20:19:03]

Done.

+              }
+            }
+          },
+          {
             "name": "callback",
             "type": "function",
             "description": "A function called when evaluation completes.",
             "optional": true,
             "parameters": [
               {
                 "name": "result",
                 "type": "object",
                 "additionalProperties": {"type": "any"},
                 "description": "The result of evaluation."
               },
               {
                 "name": "isException",

[caseq, 2014/05/15 14:31:34]

Let's also rename this to exception or exceptionInfo, since it's no longer a
bool.

[mem, 2014/05/15 20:19:03]

Done.

-                "type": "boolean",
-                "description": "Set if an exception was caught while evaluating the expression."
+                "type": "object",
+                "additionalProperties": {"type": "any"},

[caseq, 2014/05/15 14:31:34]

We may want to document some properties.
isErorr, code, description and details will be set if the error occurred on the
DevTools side before the expression is evaluated;
isException and value will be set if the evaluated code produces an unhandled
exception.

[mem, 2014/05/15 20:19:03]

Done.

+                "description": "An object providing details if an exception occurred while evaluating the expression."
               }
             ]
           }
         ]
       },
       {
         "name": "reload",
         "type": "function",
         "description": "Reloads the inspected page.",
         "parameters": [
           {
             "type": "object",
             "name": "reloadOptions",
             "optional": true,
             "properties": {
               "ignoreCache": {
                 "type": "boolean",
                 "optional": true,
                 "description": "When true, the loader will ignore the cache for all inspected page resources loaded before the <code>load</code> event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools window."
               },
               "userAgent": {
                 "type": "string",
                 "optional": true,
                 "description": "If specified, the string will override the value of the <code>User-Agent</code> HTTP header that's sent while loading the resources of the inspected page. The string will also override the value of the <code>navigator.userAgent</code> property that's returned to any scripts that are running within the inspected page."
               },
               "injectedScript": {
                 "type": "string",
                 "optional": true,
                 "description": "If specified, the script will be injected into every frame of the inspected page immediately upon load, before any of the frame's scripts. The script will not be injected after subsequent reloads&mdash;for example, if the user presses Ctrl+R."
+              },
+              "preprocessorScript": {
+                "type": "string",
+                "optional": true,
+                "description": "If specified, this is a JavaScript function that takes three string arguments: the source to preprocess, the URL of the source, and a function name if the source is an DOM event handler. The preprocessorerScript function should return a string to be compiled by Chrome in place of the input source. In the case that the source is a DOM event handler, the returned source must compile to a single JS function."

[caseq, 2014/05/15 14:31:34]

"If specified, this is a script that evaluates into a function that accepts
three string arguments ..."

[mem, 2014/05/15 20:19:03]

Done.

               }
             }
           }
         ]
       },
       {
         "name": "getResources",
         "type": "function",
         "description": "Retrieves the list of resources from the inspected page.",
         "parameters": [
@@ skipping 35 matching lines @@
           {
             "name": "content",
             "type": "string",
             "description": "New content of the resource."
           }
         ]
       }
     ]
   }
 ]