summaryrefslogtreecommitdiffstats
path: root/chrome/common
diff options
context:
space:
mode:
authorjochen@chromium.org <jochen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-09-12 08:20:38 +0000
committerjochen@chromium.org <jochen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2011-09-12 08:20:38 +0000
commit19c11e7d389077e0423e2594544b03c6a7ebc19b (patch)
tree537ecd7ae142fee61cb4243743a270a083883e4f /chrome/common
parentf180db7e8ae1a02144f51ccd0580ab0303497a9e (diff)
downloadchromium_src-19c11e7d389077e0423e2594544b03c6a7ebc19b.zip
chromium_src-19c11e7d389077e0423e2594544b03c6a7ebc19b.tar.gz
chromium_src-19c11e7d389077e0423e2594544b03c6a7ebc19b.tar.bz2
Fix and clarify webNavigation.getFrame documentation
BUG=none TEST=none Review URL: http://codereview.chromium.org/7858028 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@100655 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common')
-rw-r--r--chrome/common/extensions/api/extension_api.json5
-rw-r--r--chrome/common/extensions/docs/experimental.webNavigation.html10
2 files changed, 7 insertions, 8 deletions
diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json
index 5a273ac..17581b6 100644
--- 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. A frame refers to an <iframe> or a <frame> of a web page and is identified by a tab ID and a frame ID.",
+ "description": "Retrieves information about the given frame. A frame refers to an &lt;iframe&gt; or a &lt;frame&gt; of a web page and is identified by a tab ID and a frame ID.",
"parameters": [
{
"type": "object",
@@ -5229,6 +5229,7 @@
"type": "object",
"name": "details",
"optional": true,
+ "description": "Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.",
"properties": {
"errorOccurred": {
"type": "boolean",
@@ -5261,7 +5262,7 @@
"type": "function", "name": "callback", "parameters": [
{
"type": "array",
- "description": "A list of frames in the given tab.",
+ "description": "A list of frames in the given tab, null if the specified tab ID is invalid.",
"optional": true,
"items": {
"type": "object",
diff --git a/chrome/common/extensions/docs/experimental.webNavigation.html b/chrome/common/extensions/docs/experimental.webNavigation.html
index 134a084..53c7f1ac 100644
--- a/chrome/common/extensions/docs/experimental.webNavigation.html
+++ b/chrome/common/extensions/docs/experimental.webNavigation.html
@@ -722,7 +722,7 @@ unexpected results.
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>A list of frames in the given tab.</dd>
+ <dd>A list of frames in the given tab, null if the specified tab ID is invalid.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -785,7 +785,7 @@ unexpected results.
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</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>
+ <p>Retrieves information about the given frame. A frame refers to an &lt;iframe&gt; or a &lt;frame&gt; of a web page and is identified by a tab ID and a frame ID.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
@@ -1117,12 +1117,10 @@ unexpected results.
</em>
</dt>
- <dd class="todo">
+ <dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd style="display: none; ">
- Description of this parameter from the json schema.
- </dd>
+ <dd>Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.