Anoher clean-up for chrome.experimental.devtools.* docs

chrome/common/extensions/api/devtools_api.json

 [
   {
     "namespace": "experimental.devtools.inspectedWindow",
     "types": [
       {
         "id": "Resource",
         "type": "object",
-        "description": "A resource within the inspected page, such as a document, a script or an image.",
+        "description": "A resource within the inspected page, such as a document, a script, or an image.",
         "properties": {
           "url": {
             "type": "string",
             "description": "The URL of the resource."
           }
         },
         "functions": [
           {
             "name": "getContent",
             "type": "function",
             "description": "Gets the content of the resource.",
             "parameters": [
               {
                 "name": "callback",
                 "type": "function",
-                "description": "A function that is called upon request completion.",
+                "description": "A function that receives resource content when the request completes.",
                 "parameters": [
                   {
                     "name": "content",
                     "type": "string",
                     "description": "Content of the resource (potentially encoded)."
                   },
                   {
                     "name": "encoding",
                     "type": "string",
                     "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported."
                   }
                 ]
               }
             ]
           },
           {
             "name": "setContent",
             "type": "function",
             "description": "Sets the content of the resource.",
             "parameters": [
               {
                 "name": "content",
                 "type": "string",
                 "description": "New content of the resource. Only resources with the text type are currently supported."
               },
               {
                 "name": "commit",
                 "type": "boolean",
-                "description": "True if the user has finished editing the resource and the new content of the resource should be persisted, false if this is a minor change sent in progress of the user editing the resource."
+                "description": "True if the user has finished editing the resource, and the new content of the resource should be persisted; false if this is a minor change sent in progress of the user editing the resource."
               },
               {
                 "name": "callback",
                 "type": "function",
                 "description": "A function called upon request completion.",
+                "optional": true,
                 "parameters": [
                   {
                     "name": "error",
                     "type": "object",
                     "optional": true,
-                    "description": "Set to undefined if the operation completed successfully, describes error otherwise."
+                    "description": "Set to undefined if the resource content was set successfully; describes error otherwise."
                   }
                 ]
               }
             ]
           }
         ]
       }
     ],
     "properties": {
       "tabId": {
         "description": "The ID of the tab being inspected. This ID may be used with chrome.tabs.* API.",
         "type": "integer"
       }
     },
     "functions": [
       {
         "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": "callback",
             "type": "function",
             "description": "A function called when evaluation completes.",
+            "optional": true,
             "parameters": [
               {
                 "name": "result",
                 "type": "object",
                 "description": "The result of evaluation."
               },
               {
                 "name": "isException",
                 "type": "boolean",
-                "description": "Set if an exception was caught while evaluating the expression"
+                "description": "Set if an exception was caught while evaluating the expression."
               }
             ]
           }
         ]
       },
       {
         "name": "reload",
         "type": "function",
         "description": "Reloads the inspected page.",
         "parameters": [
@@ skipping 22 matching lines @@
         ]
       },
       {
         "name": "getResources",
         "type": "function",
         "description": "Retrieves the list of resources from the inspected page.",
         "parameters": [
           {
             "name": "callback",
             "type": "function",
-            "description": "A function that is called upon request completion.",
+            "description": "A function that receives the list of resources when the request completes.",
             "parameters": [
               {
                 "name": "resources",
                 "type": "array",
                 "items": { "$ref": "Resource" },
                 "description": "The resources within the page."
               }
             ]
           }
         ]
@@ skipping 19 matching lines @@
             "$ref": "Resource"
           }
         ]
       }
     ]
   },
   {
     "namespace": "experimental.devtools.panels",
     "types": [
       {
-        "id": "PanelWithSidebars",
+        "id": "ElementsPanel",
         "type": "object",
-        "isInstanceOf": "Panel",
-        "description": "A panel within Web Inspector UI that has sidebars.",
+        "description": "Represents the Elements panel.",
+        "events": [
+          {
+            "name": "onSelectionChanged",
+            "description": "Fired when an object is selected in the panel."
+          }
+        ],
         "functions": [
           {
             "name": "createSidebarPane",
             "type": "function",
             "description": "Creates a pane within panel's sidebar.",
             "parameters": [
               {
                 "name": "title",
                 "type": "string",
-                "description": "A text that is displayed in sidebar caption."
+                "description": "Text that is displayed in sidebar caption."
               },
               {
                 "name": "callback",
                 "type": "function",
-                "description": "A callback invoked when sidebar is created.",
+                "description": "A callback invoked when the sidebar is created.",
+                "optional": true,
                 "parameters": [
                   {
                     "name": "result",
                     "description": "An ExtensionSidebarPane object for created sidebar pane.",
                     "$ref": "ExtensionSidebarPane"
                   }
                 ]
               }
             ]
           }
         ]
       },
       {
-        "id": "ElementsPanel",
-        "type": "object",
-        "isInstanceOf": "PanelWithSidebars",
-        "description": "Represents Elements panel",
-        "events": [
-          {
-            "name": "onSelectionChanged",
-            "description": "Fired when an object is selected in the panel."
-          }
-        ]
-      },
-      {
         "id": "ExtensionPanel",
         "type": "object",
-        "isInstanceOf": "Panel",
         "description": "Represents a panel created by extension.",
         "events": [
           {
             "name": "onSearch",
-            "description": "Fired upon a search action (start of a new search, search result navigation or search being canceled).",
+            "description": "Fired upon a search action (start of a new search, search result navigation, or search being canceled).",
             "parameters": [
               {
                 "name": "action",
                 "type": "string",
                 "description": "Type of search action being performed."
               },
               {
                 "name": "queryString",
                 "type": "string",
                 "optional": true,
                 "description": "Query string (only for 'performSearch')."
               }
             ]
+          },
+          {
+            "name": "onShown",
+            "type": "function",
+            "description": "Fired when the user switches to the panel.",
+            "parameters": [
+              { 
+                "name": "window",
+                "type": "DOMWindow",
+                "description": "The <code>window</code> object of panel's page."
+              }
+            ]
+          },
+          {
+            "name": "onHidden",
+            "type": "function",
+            "description": "Fired when the user switches away from the panel."
           }
         ]
       },
       {
         "id": "ExtensionSidebarPane",
         "type": "object",
         "description": "A sidebar created by the extension.",
         "functions": [
           {
             "name": "setHeight",
@@ skipping 42 matching lines @@
                 "description": "An optional title for the root of the expression tree."
               }
             ]
           },
           {
             "name": "setPage",
             "type": "function",
             "description": "Sets an HTML page to be displayed in the sidebar pane.",
             "parameters": [
               {
-                "name": "url",
+                "name": "path",
                 "type": "string",
-                "description": "A URL of an extension page to display within the sidebar."
+                "description": "Relative path of an extension page to display within the sidebar."
               }
             ]
           }
+        ],
+        "events": [
+          {
+            "name": "onShown",
+            "type": "function",
+            "description": "Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.",
+            "parameters": [
+              { 
+                "name": "window",
+                "type": "DOMWindow",
+                "optional": true,
+                "description": "The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method."
+              }
+            ]
+          },
+          {
+            "name": "onHidden",
+            "type": "function",
+            "description": "Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane."
+          }
         ]
       }
     ],
     "properties": {
       "elements": {
         "$ref": "ElementsPanel",
         "description": "Elements panel."
       }
     },
     "functions": [
       {
         "name": "create",
         "type": "function",
         "description": "Creates an extension panel.",
         "parameters": [
           {
             "name": "title",
             "type": "string",
-            "description": "Title that is displayed under the extension icon in the toolbar."
+            "description": "Title that is displayed next to the extension icon in the Developer Tools toolbar."
           },
           {
-            "name": "iconURL",
+            "name": "iconPath",
             "type": "string",
-            "description": "A URL of the toolbar icon."
+            "description": "Path of the panel's icon relative to the extension directory."
           },
           {
-            "name": "pageURL",
+            "name": "pagePath",
             "type": "string",
-            "description": "A URL of the page that represents this panel."
+            "description": "Path of the panel's HTML page relative to the extension directory."
           },
           {
             "name": "callback",
             "type": "function",
-            "description": "A function that is called upon request completion.",
+            "optional": true,
+            "description": "A function that is called when the panel is created.",
             "parameters": [
               {
                 "name": "panel",
                 "description": "An ExtensionPanel object representing the created panel.",
                 "$ref": "ExtensionPanel"
               }
             ]
           }
         ]
       },
@@ skipping 18 matching lines @@
         ]
       }
     ]
   },
   {
     "namespace": "experimental.devtools.network",
     "types": [
       {
         "id": "Request",
         "type": "object",
-        "description": "Represents a network request for a document resource (script, image etc). See HAR Specification for reference.",
+        "description": "Represents a network request for a document resource (script, image and so on). See HAR Specification for reference.",
         "functions": [
           {
             "name": "getContent",
             "type": "function",
             "description": "Returns content of the response body.",
             "parameters": [
               {
                 "name": "callback",
                 "type": "function",
-                "description": "A function that is called upon request completion.",
+                "description": "A function that receives the response body when the request completes.",
                 "parameters": [
                   {
                     "name": "content",
                     "type": "string",
                     "description": "Content of the response body (potentially encoded)."
                   },
                   {
                     "name": "encoding",
                     "type": "string",
                     "description": "Empty if content is not encoded, encoding name otherwise. Currently, only base64 is supported."
                   }
                 ]
               }
             ]
           }
         ]
       }
     ],
     "functions": [
       {
         "name": "getHAR",
         "type": "function",
-        "description": "Returns HAR archive that contains all known network requests.",
+        "description": "Returns HAR log that contains all known network requests.",
         "parameters": [
           {
             "name": "callback",
             "type": "function",
-            "description": "A function that is called upon request completion.",
+            "description": "A function that receives the HAR log when the request completes.",
             "parameters": [
               {
-                "name": "har",
+                "name": "harLog",
                 "type": "object",
-                "description": "A HAR archive. See HAR specification for details."
+                "description": "A HAR log. See HAR specification for details."
               }
             ]
           }
         ]
       }
     ],
     "events": [
       {
         "name": "onRequestFinished",
         "type": "function",
@@ skipping 29 matching lines @@
         ]
       },
       {
         "name": "getMessages",
         "type": "function",
         "description": "Retrieves console messages.",
         "parameters": [
           {
             "name": "callback",
             "type": "function",
-            "description": "A function that is called upon request completion.",
+            "description": "A function that receives console messages when the request completes.",
             "parameters": [
               {
                 "name": "messages",
                 "type": "array",
                 "items": { "$ref": "ConsoleMessage" },
                 "description": "Console messages."
               }
             ]
           }
         ]
@@ skipping 218 matching lines @@
         "properties": {
           "expanded": {
             "type": "boolean",
             "description": "If set, the subtree will always be expanded."
           }
         }
       },
       {
         "id": "AuditResultSeverity",
         "type": "object",
-        "description": "This type contains possible values for a result severity. The results of different severities are distinguished by colored bullets near the result's display name.", 
+        "description": "This type contains possible values for a result severity. The results of different severities are distinguished by colored bullets near the result's display name.",
         "properties": {
           "Info": {
             "type": "string"
           },
           "Warning": {
             "type": "string"
           },
           "Severe": {
             "type": "string"
           }
         }
       }
     ]
   }
 ]