Skip to content

GitLab

T
tangled
Commit c7fc13fb authored by caseq@chromium.org's avatar caseq@chromium.org
Browse files
Options

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

- marked most callbacks as optional;
- merged PanelWithSidebars into ElementsPanel;
- more specific description for most of the callbacks;
- misc puntuation fixes;^H.

BUG=none
TEST=none


Review URL: http://codereview.chromium.org/8538005

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@110485 0039d316-1c4b-4281-b951-d872f2087c98
parent 14b92da2
Hide whitespace changes
Inline Side-by-side
Showing with 453 additions and 184 deletions
chrome/common/extensions/api/devtools_api.json
View file @ c7fc13fb
......@@ -5,7 +5,7 @@
{
"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",
......@@ -21,7 +21,7 @@
{
"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",
......@@ -50,18 +50,19 @@
{
"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."
}
]
}
......@@ -91,6 +92,7 @@
"name": "callback",
"type": "function",
"description": "A function called when evaluation completes.",
"optional": true,
"parameters": [
{
"name": "result",
......@@ -100,7 +102,7 @@
{
"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."
}
]
}
......@@ -143,7 +145,7 @@
{
"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",
......@@ -183,10 +185,15 @@
"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",
......@@ -196,12 +203,13 @@
{
"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",
......@@ -214,27 +222,14 @@
}
]
},
{
"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",
......@@ -248,6 +243,23 @@
"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."
}
]
},
......@@ -310,12 +322,32 @@
"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."
}
]
}
],
......@@ -334,22 +366,23 @@
{
"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",
......@@ -388,7 +421,7 @@
{
"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",
......@@ -398,7 +431,7 @@
{
"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",
......@@ -421,17 +454,17 @@
{
"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."
}
]
}
......@@ -481,7 +514,7 @@
{
"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",
......@@ -720,7 +753,7 @@
{
"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"
......
chrome/common/extensions/docs/experimental.devtools.console.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>chrome.experimental.devtools.console API - Google Chrome Extensions - Google Code</title></head>
<title>chrome.experimental.devtools.console
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......@@ -683,7 +684,7 @@ allows an extension to add new messages.
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that receives console messages when the request completes.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......
chrome/common/extensions/docs/experimental.devtools.inspectedWindow.html
View file @ c7fc13fb
......@@ -587,7 +587,7 @@ You can find more examples that use Developer Tools APIs in
<div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.devtools.inspectedWindow.eval</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>expression</span></var></span><span class="null"><span>, </span><span>function</span>
<var><span>expression</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
......@@ -674,7 +674,7 @@ You can find more examples that use Developer Tools APIs in
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" style="display: none; ">optional</span>
<span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -749,11 +749,11 @@ You can find more examples that use Developer Tools APIs in
<div>
<div>
<h4>Callback function</h4>
<p>
<p style="display: none; ">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p style="display: none; ">
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
......@@ -860,7 +860,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Set if an exception was caught while evaluating the expression</dd>
<dd>Set if an exception was caught while evaluating the expression.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -958,7 +958,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that receives the list of resources when the request completes.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1725,7 +1725,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A resource within the inspected page, such as a document, a script or an image.</dd>
<dd>A resource within the inspected page, such as a document, a script, or an image.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1865,7 +1865,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that receives resource content when the request completes.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1918,7 +1918,7 @@ You can find more examples that use Developer Tools APIs in
<div>
<div>
<h4>Callback function</h4>
<p>
<p style="">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
......@@ -2088,7 +2088,7 @@ You can find more examples that use Developer Tools APIs in
<!-- Note: intentionally longer 80 columns -->
<span>resource.setContent</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>content</span></var></span><span class="null"><span style="">, </span><span>boolean</span>
<var><span>commit</span></var></span><span class="null"><span style="">, </span><span>function</span>
<var><span>commit</span></var></span><span class="optional"><span style="">, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
......@@ -2197,7 +2197,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>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.</dd>
<dd>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.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -2243,7 +2243,7 @@ You can find more examples that use Developer Tools APIs in
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" style="display: none; ">optional</span>
<span class="optional" style="">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -2318,11 +2318,11 @@ You can find more examples that use Developer Tools APIs in
<div>
<div>
<h4>Callback function</h4>
<p>
<p style="display: none; ">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p style="display: none; ">
<p style="">
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
......@@ -2372,7 +2372,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Set to undefined if the operation completed successfully, describes error otherwise.</dd>
<dd>Set to undefined if the resource content was set successfully; describes error otherwise.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......
chrome/common/extensions/docs/experimental.devtools.network.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>chrome.experimental.devtools.network API - Google Chrome Extensions - Google Code</title></head>
<title>chrome.experimental.devtools.network
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......@@ -481,7 +482,7 @@ You can find more examples that use this API in
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Returns HAR archive that contains all known network requests.</p>
<p>Returns HAR log that contains all known network requests.</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
......@@ -517,7 +518,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that receives the HAR log when the request completes.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -580,12 +581,12 @@ You can find more examples that use this API in
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span>object har</span>) <span class="subdued">{...}</span>;</pre>
<pre>function(<span>object harLog</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
<dt>
<var>har</var>
<var>harLog</var>
<em>
<!-- TYPE -->
......@@ -613,7 +614,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A HAR archive. See HAR specification for details.</dd>
<dd>A HAR log. See HAR specification for details.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -937,7 +938,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Represents a network request for a document resource (script, image etc). See HAR Specification for reference.</dd>
<dd>Represents a network request for a document resource (script, image and so on). See HAR Specification for reference.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1012,7 +1013,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that receives the response body when the request completes.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......
chrome/common/extensions/docs/experimental.devtools.panels.html
View file @ c7fc13fb
......@@ -348,33 +348,13 @@
<a href="#types">Types</a>
<ol>
<li>
<a href="#type-PanelWithSidebars">PanelWithSidebars</a>
<ol>
<li>
<a href="#global-PanelWithSidebars-methods">Methods</a>
<ol>
<li>
<a href="#method-PanelWithSidebars-createSidebarPane">createSidebarPane</a>
</li>
</ol>
</li>
<li style="display: none; ">
<a>Events</a>
<ol>
<li>
<a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
</ol>
</li><li>
<a href="#type-ElementsPanel">ElementsPanel</a>
<ol>
<li style="display: none; ">
<a>Methods</a>
<li>
<a href="#global-ElementsPanel-methods">Methods</a>
<ol>
<li>
<a href="#method-anchor">methodName</a>
<a href="#method-ElementsPanel-createSidebarPane">createSidebarPane</a>
</li>
</ol>
</li>
......@@ -402,7 +382,11 @@
<a href="#global-ExtensionPanel-events">Events</a>
<ol>
<li>
<a href="#event-ExtensionPanel-onHidden">onHidden</a>
</li><li>
<a href="#event-ExtensionPanel-onSearch">onSearch</a>
</li><li>
<a href="#event-ExtensionPanel-onShown">onShown</a>
</li>
</ol>
</li>
......@@ -424,11 +408,13 @@
</li>
</ol>
</li>
<li style="display: none; ">
<a>Events</a>
<li>
<a href="#global-ExtensionSidebarPane-events">Events</a>
<ol>
<li>
<a href="#event-anchor">eventName</a>
<a href="#event-ExtensionSidebarPane-onHidden">onHidden</a>
</li><li>
<a href="#event-ExtensionSidebarPane-onShown">onShown</a>
</li>
</ol>
</li>
......@@ -612,8 +598,8 @@ You can find examples that use this API in
<!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.devtools.panels.create</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>title</span></var></span><span class="null"><span>, </span><span>string</span>
<var><span>iconURL</span></var></span><span class="null"><span>, </span><span>string</span>
<var><span>pageURL</span></var></span><span class="null"><span>, </span><span>function</span>
<var><span>iconPath</span></var></span><span class="null"><span>, </span><span>string</span>
<var><span>pagePath</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
......@@ -654,7 +640,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Title that is displayed under the extension icon in the toolbar.</dd>
<dd>Title that is displayed next to the extension icon in the Developer Tools toolbar.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -694,7 +680,7 @@ You can find examples that use this API in
</div><div>
<div>
<dt>
<var>iconURL</var>
<var>iconPath</var>
<em>
<!-- TYPE -->
......@@ -722,7 +708,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A URL of the toolbar icon.</dd>
<dd>Path of the panel's icon relative to the extension directory.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -762,7 +748,7 @@ You can find examples that use this API in
</div><div>
<div>
<dt>
<var>pageURL</var>
<var>pagePath</var>
<em>
<!-- TYPE -->
......@@ -790,7 +776,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A URL of the page that represents this panel.</dd>
<dd>Path of the panel's HTML page relative to the extension directory.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -836,7 +822,7 @@ You can find examples that use this API in
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" style="display: none; ">optional</span>
<span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -858,7 +844,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A function that is called upon request completion.</dd>
<dd>A function that is called when the panel is created.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -911,11 +897,11 @@ You can find examples that use this API in
<div>
<div>
<h4>Callback function</h4>
<p>
<p style="display: none; ">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p style="display: none; ">
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
......@@ -1266,8 +1252,8 @@ You can find examples that use this API in
<!-- iterates over all types -->
<div class="apiItem">
<a name="type-PanelWithSidebars"></a>
<h4>PanelWithSidebars</h4>
<a name="type-ElementsPanel"></a>
<h4>ElementsPanel</h4>
<div>
<dt>
......@@ -1287,7 +1273,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
<span>Panel</span>
<span>object</span>
<span style="display: none; "></span>
</span>
</span>
......@@ -1299,7 +1285,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A panel within Web Inspector UI that has sidebars.</dd>
<dd>Represents the Elements panel.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1323,18 +1309,18 @@ You can find examples that use this API in
<!-- OBJECT METHODS -->
<dd>
<div class="apiGroup">
<a name="global-PanelWithSidebars-methods"></a>
<h3>Methods of PanelWithSidebars</h3>
<a name="global-ElementsPanel-methods"></a>
<h3>Methods of ElementsPanel</h3>
<!-- iterates over all functions -->
<div class="apiItem">
<a name="method-PanelWithSidebars-createSidebarPane"></a> <!-- method-anchor -->
<a name="method-ElementsPanel-createSidebarPane"></a> <!-- method-anchor -->
<h4>createSidebarPane</h4>
<div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
<span>panelWithSidebars.createSidebarPane</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>title</span></var></span><span class="null"><span>, </span><span>function</span>
<span>elementsPanel.createSidebarPane</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>title</span></var></span><span class="optional"><span>, </span><span>function</span>
<var><span>callback</span></var></span>)</div>
<div class="description">
......@@ -1375,7 +1361,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A text that is displayed in sidebar caption.</dd>
<dd>Text that is displayed in sidebar caption.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1421,7 +1407,7 @@ You can find examples that use this API in
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" style="display: none; ">optional</span>
<span class="optional" style="">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -1443,7 +1429,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A callback invoked when sidebar is created.</dd>
<dd>A callback invoked when the sidebar is created.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1496,11 +1482,11 @@ You can find examples that use this API in
<div>
<div>
<h4>Callback function</h4>
<p>
<p style="display: none; ">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p style="display: none; ">
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
......@@ -1596,8 +1582,59 @@ You can find examples that use this API in
</dd>
<!-- OBJECT EVENT FIELDS -->
<dd style="display: none; ">
<div></div>
<dd>
<div class="apiGroup" style="">
<a name="global-ElementsPanel-events"></a>
<h3>Events of ElementsPanel</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="event-ElementsPanel-onSelectionChanged"></a>
<h4>onSelectionChanged</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">elementsPanel.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired when an object is selected in the panel.</p>
<!-- LISTENER PARAMETERS -->
<div style="display: none; ">
<h4>Listener parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<div style="display: none; ">
<h4>Extra parameters to addListener</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- LISTENER RETURN VALUE -->
<h4 style="display: none; ">Listener returns</h4>
<dl>
<div style="display: none; ">
<div>
</div>
</div>
</dl>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div>
</dd>
<!-- FUNCTION PARAMETERS -->
......@@ -1608,8 +1645,8 @@ You can find examples that use this API in
</div>
</div><div class="apiItem">
<a name="type-ElementsPanel"></a>
<h4>ElementsPanel</h4>
<a name="type-ExtensionPanel"></a>
<h4>ExtensionPanel</h4>
<div>
<dt>
......@@ -1629,7 +1666,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
<span>PanelWithSidebars</span>
<span>object</span>
<span style="display: none; "></span>
</span>
</span>
......@@ -1641,7 +1678,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Represents Elements panel</dd>
<dd>Represents a panel created by extension.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1670,21 +1707,21 @@ You can find examples that use this API in
<!-- OBJECT EVENT FIELDS -->
<dd>
<div class="apiGroup" style="">
<a name="global-ElementsPanel-events"></a>
<h3>Events of ElementsPanel</h3>
<a name="global-ExtensionPanel-events"></a>
<h3>Events of ExtensionPanel</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="event-ElementsPanel-onSelectionChanged"></a>
<h4>onSelectionChanged</h4>
<a name="event-ExtensionPanel-onHidden"></a>
<h4>onHidden</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">elementsPanel.</span><span>onSelectionChanged</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
<span class="subdued">extensionPanel.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired when an object is selected in the panel.</p>
<p>Fired when the user switches away from the panel.</p>
<!-- LISTENER PARAMETERS -->
<div style="display: none; ">
......@@ -1718,25 +1755,27 @@ You can find examples that use this API in
</dl>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div>
</dd>
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div><div class="apiItem">
<a name="event-ExtensionPanel-onSearch"></a>
<h4>onSearch</h4>
</div>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">extensionPanel.</span><span>onSearch</span><span class="subdued">.addListener</span>(function(<span>string action, string queryString</span>) <span class="subdued">{...}</span><span></span>);
</div>
</div><div class="apiItem">
<a name="type-ExtensionPanel"></a>
<h4>ExtensionPanel</h4>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired upon a search action (start of a new search, search result navigation, or search being canceled).</p>
<div>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
<dt>
<var style="display: none; ">paramName</var>
<var>action</var>
<em>
<!-- TYPE -->
......@@ -1752,7 +1791,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
<span>Panel</span>
<span>string</span>
<span style="display: none; "></span>
</span>
</span>
......@@ -1764,7 +1803,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Represents a panel created by extension.</dd>
<dd>Type of search action being performed.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1791,38 +1830,26 @@ You can find examples that use this API in
</dd>
<!-- OBJECT EVENT FIELDS -->
<dd>
<div class="apiGroup" style="">
<a name="global-ExtensionPanel-events"></a>
<h3>Events of ExtensionPanel</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="event-ExtensionPanel-onSearch"></a>
<h4>onSearch</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">extensionPanel.</span><span>onSearch</span><span class="subdued">.addListener</span>(function(<span>string action, string queryString</span>) <span class="subdued">{...}</span><span></span>);
</div>
<dd style="display: none; ">
<div></div>
</dd>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired upon a search action (start of a new search, search result navigation or search being canceled).</p>
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
</div>
</div><div>
<div>
<dt>
<var>action</var>
<var>queryString</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" style="display: none; ">optional</span>
<span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -1844,7 +1871,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Type of search action being performed.</dd>
<dd>Query string (only for 'performSearch').</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -1881,16 +1908,58 @@ You can find examples that use this API in
</dd>
</div>
</div><div>
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<div style="display: none; ">
<h4>Extra parameters to addListener</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- LISTENER RETURN VALUE -->
<h4 style="display: none; ">Listener returns</h4>
<dl>
<div style="display: none; ">
<div>
</div>
</div>
</dl>
</div> <!-- /description -->
</div><div class="apiItem">
<a name="event-ExtensionPanel-onShown"></a>
<h4>onShown</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">extensionPanel.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired when the user switches to the panel.</p>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
<dt>
<var>queryString</var>
<var>window</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
......@@ -1900,7 +1969,7 @@ You can find examples that use this API in
<span style="display: none; ">
array of <span><span></span></span>
</span>
<span>string</span>
<span>DOMWindow</span>
<span style="display: none; "></span>
</span>
</span>
......@@ -1912,7 +1981,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>Query string (only for 'performSearch').</dd>
<dd>The <code>window</code> object of panel's page.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -2217,11 +2286,11 @@ You can find examples that use this API in
<div style="display: none; ">
<div>
<h4>Callback function</h4>
<p>
<p style="display: none; ">
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
<p style="display: none; ">
<p>
If you specify the <em>callback</em> parameter, it should
specify a function that looks like this:
</p>
......@@ -2775,7 +2844,7 @@ You can find examples that use this API in
<div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
<span>extensionSidebarPane.setPage</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
<var><span>url</span></var></span>)</div>
<var><span>path</span></var></span>)</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
......@@ -2787,7 +2856,7 @@ You can find examples that use this API in
<div>
<div>
<dt>
<var>url</var>
<var>path</var>
<em>
<!-- TYPE -->
......@@ -2815,7 +2884,7 @@ You can find examples that use this API in
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>A URL of an extension page to display within the sidebar.</dd>
<dd>Relative path of an extension page to display within the sidebar.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
......@@ -2968,10 +3037,171 @@ You can find examples that use this API in
</dd>
<!-- OBJECT EVENT FIELDS -->
<dd>
<div class="apiGroup" style="">
<a name="global-ExtensionSidebarPane-events"></a>
<h3>Events of ExtensionSidebarPane</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a name="event-ExtensionSidebarPane-onHidden"></a>
<h4>onHidden</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">extensionSidebarPane.</span><span>onHidden</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar pane.</p>
<!-- LISTENER PARAMETERS -->
<div style="display: none; ">
<h4>Listener parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<div style="display: none; ">
<h4>Extra parameters to addListener</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- LISTENER RETURN VALUE -->
<h4 style="display: none; ">Listener returns</h4>
<dl>
<div style="display: none; ">
<div>
</div>
</div>
</dl>
</div> <!-- /description -->
</div><div class="apiItem">
<a name="event-ExtensionSidebarPane-onShown"></a>
<h4>onShown</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">extensionSidebarPane.</span><span>onShown</span><span class="subdued">.addListener</span>(function(<span>DOMWindow window</span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
<p>Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.</p>
<!-- LISTENER PARAMETERS -->
<div>
<h4>Listener parameters</h4>
<dl>
<div>
<div>
<dt>
<var>window</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
<a> Type</a>
</span>
<span>
<span style="display: none; ">
array of <span><span></span></span>
</span>
<span>DOMWindow</span>
<span style="display: none; "></span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
<dd>The <code>window</code> object of the sidebar page, if one was set with the <code>setPage()</code> method.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
You must omit this parameter in earlier versions,
and you may omit it in any version. If you require this
parameter, the manifest key
<a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
can ensure that your extension won't be run in an earlier browser version.
</dd>
<!-- OBJECT PROPERTIES -->
<dd style="display: none; ">
<dl>
<div>
<div>
</div>
</div>
</dl>
</dd>
<!-- OBJECT METHODS -->
<dd style="display: none; ">
<div></div>
</dd>
<!-- OBJECT EVENT FIELDS -->
<dd style="display: none; ">
<div></div>
</dd>
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
</dd>
</div>
</div>
</dl>
</div>
<!-- EXTRA PARAMETERS -->
<div style="display: none; ">
<h4>Extra parameters to addListener</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
<!-- LISTENER RETURN VALUE -->
<h4 style="display: none; ">Listener returns</h4>
<dl>
<div style="display: none; ">
<div>
</div>
</div>
</dl>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div>
</dd>
<!-- FUNCTION PARAMETERS -->
<dd style="display: none; ">
<div></div>
......
chrome/common/extensions/docs/experimental.devtools.resources.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>chrome.experimental.devtools.resources API - Google Chrome Extensions - Google Code</title></head>
<title>chrome.experimental.devtools.resources
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......
chrome/common/extensions/docs/experimental.webInspector.audits.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>experimental.webInspector.audits API - Google Chrome Extensions - Google Code</title></head>
<title>experimental.webInspector.audits
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......
chrome/common/extensions/docs/experimental.webInspector.panels.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>experimental.webInspector.panels API - Google Chrome Extensions - Google Code</title></head>
<title>experimental.webInspector.panels
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......
chrome/common/extensions/docs/experimental.webInspector.resources.html
View file @ c7fc13fb
......@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
<title>experimental.webInspector.resources API - Google Chrome Extensions - Google Code</title></head>
<title>experimental.webInspector.resources
API - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment