Clarify extension API docs for webNavigation

BUG=95641 TEST=none Review URL: http://codereview.chromium.org/7795047 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@100143 0039d316-1c4b-4281-b951-d872f2087c98
excellent-media · Sep 8, 2011 · 34fcb8f · 34fcb8f
1 parent b6ea339
commit 34fcb8f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json
@@ -5212,7 +5212,7 @@
       {
         "name": "getFrame",
         "type": "function",
-        "description": "Retrieves information about the given frame.",
+        "description": "Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.",
         "parameters": [
           {
             "type": "object",
@@ -5318,7 +5318,7 @@
       {
         "name": "onErrorOccurred",
         "type": "function",
-        "description": "Fired when an error occurs.",
+        "description": "Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.",
         "parameters": [
           {
             "type": "object",

diff --git a/chrome/common/extensions/docs/experimental.webNavigation.html b/chrome/common/extensions/docs/experimental.webNavigation.html
@@ -388,7 +388,7 @@ <h4>getFrame</h4>
 
               <div class="description">
                 <p class="todo" style="display: none; ">Undocumented.</p>
-                <p>Retrieves information about the given frame.</p>
+                <p>Retrieves information about the given frame. A frame refers to an <iframe> or a &lt;frame&gt; of a web page and is identified by a tab ID and a frame ID.</iframe></p>
 
                 <!-- PARAMETERS -->
                 <h4>Parameters</h4>
@@ -3046,7 +3046,7 @@ <h4>onErrorOccurred</h4>
 
               <div class="description">
                 <p class="todo" style="display: none; ">Undocumented.</p>
-                <p>Fired when an error occurs.</p>
+                <p>Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.</p>
 
                 <!-- LISTENER PARAMETERS -->
                 <div>