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
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 453 additions and 184 deletions
chrome/common/extensions/docs/experimental.devtools.console.html
View file @ c7fc13fb
...@@ -16,7 +16,8 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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. ...@@ -683,7 +684,7 @@ allows an extension to add new messages.
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <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 ...@@ -587,7 +587,7 @@ You can find more examples that use Developer Tools APIs in
<div class="summary"><span style="display: none; ">void</span> <div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns --> <!-- Note: intentionally longer 80 columns -->
<span>chrome.experimental.devtools.inspectedWindow.eval</span>(<span class="null"><span style="display: none; ">, </span><span>string</span> <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> <var><span>callback</span></var></span>)</div>
<div class="description"> <div class="description">
...@@ -674,7 +674,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -674,7 +674,7 @@ You can find more examples that use Developer Tools APIs in
<!-- TYPE --> <!-- TYPE -->
<div style="display:inline"> <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 class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate"> <span id="typeTemplate">
<span style="display: none; "> <span style="display: none; ">
...@@ -749,11 +749,11 @@ You can find more examples that use Developer Tools APIs in ...@@ -749,11 +749,11 @@ You can find more examples that use Developer Tools APIs in
<div> <div>
<div> <div>
<h4>Callback function</h4> <h4>Callback function</h4>
<p> <p style="display: none; ">
The callback <em>parameter</em> should specify a function The callback <em>parameter</em> should specify a function
that looks like this: that looks like this:
</p> </p>
<p style="display: none; "> <p>
If you specify the <em>callback</em> parameter, it should If you specify the <em>callback</em> parameter, it should
specify a function that looks like this: specify a function that looks like this:
</p> </p>
...@@ -860,7 +860,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -860,7 +860,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -958,7 +958,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -958,7 +958,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -1725,7 +1725,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -1725,7 +1725,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -1865,7 +1865,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -1865,7 +1865,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -1918,7 +1918,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -1918,7 +1918,7 @@ You can find more examples that use Developer Tools APIs in
<div> <div>
<div> <div>
<h4>Callback function</h4> <h4>Callback function</h4>
<p> <p style="">
The callback <em>parameter</em> should specify a function The callback <em>parameter</em> should specify a function
that looks like this: that looks like this:
</p> </p>
...@@ -2088,7 +2088,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -2088,7 +2088,7 @@ You can find more examples that use Developer Tools APIs in
<!-- Note: intentionally longer 80 columns --> <!-- Note: intentionally longer 80 columns -->
<span>resource.setContent</span>(<span class="null"><span style="display: none; ">, </span><span>string</span> <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>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> <var><span>callback</span></var></span>)</div>
<div class="description"> <div class="description">
...@@ -2197,7 +2197,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -2197,7 +2197,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -2243,7 +2243,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -2243,7 +2243,7 @@ You can find more examples that use Developer Tools APIs in
<!-- TYPE --> <!-- TYPE -->
<div style="display:inline"> <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 class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate"> <span id="typeTemplate">
<span style="display: none; "> <span style="display: none; ">
...@@ -2318,11 +2318,11 @@ You can find more examples that use Developer Tools APIs in ...@@ -2318,11 +2318,11 @@ You can find more examples that use Developer Tools APIs in
<div> <div>
<div> <div>
<h4>Callback function</h4> <h4>Callback function</h4>
<p> <p style="display: none; ">
The callback <em>parameter</em> should specify a function The callback <em>parameter</em> should specify a function
that looks like this: that looks like this:
</p> </p>
<p style="display: none; "> <p style="">
If you specify the <em>callback</em> parameter, it should If you specify the <em>callback</em> parameter, it should
specify a function that looks like this: specify a function that looks like this:
</p> </p>
...@@ -2372,7 +2372,7 @@ You can find more examples that use Developer Tools APIs in ...@@ -2372,7 +2372,7 @@ You can find more examples that use Developer Tools APIs in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
......
chrome/common/extensions/docs/experimental.devtools.network.html
View file @ c7fc13fb
...@@ -16,7 +16,8 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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 ...@@ -481,7 +482,7 @@ You can find more examples that use this API in
<div class="description"> <div class="description">
<p class="todo" style="display: none; ">Undocumented.</p> <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 --> <!-- PARAMETERS -->
<h4>Parameters</h4> <h4>Parameters</h4>
...@@ -517,7 +518,7 @@ You can find more examples that use this API in ...@@ -517,7 +518,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -580,12 +581,12 @@ You can find more examples that use this API in ...@@ -580,12 +581,12 @@ You can find more examples that use this API in
</p> </p>
<!-- Note: intentionally longer 80 columns --> <!-- 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> <dl>
<div> <div>
<div> <div>
<dt> <dt>
<var>har</var> <var>harLog</var>
<em> <em>
<!-- TYPE --> <!-- TYPE -->
...@@ -613,7 +614,7 @@ You can find more examples that use this API in ...@@ -613,7 +614,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -937,7 +938,7 @@ You can find more examples that use this API in ...@@ -937,7 +938,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
...@@ -1012,7 +1013,7 @@ You can find more examples that use this API in ...@@ -1012,7 +1013,7 @@ You can find more examples that use this API in
<dd class="todo" style="display: none; "> <dd class="todo" style="display: none; ">
Undocumented. Undocumented.
</dd> </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; "> <dd style="display: none; ">
This parameter was added in version This parameter was added in version
<b><span></span></b>. <b><span></span></b>.
......
chrome/common/extensions/docs/experimental.devtools.resources.html
View file @ c7fc13fb
...@@ -16,7 +16,8 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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 @@ ...@@ -16,7 +16,8 @@
<script type="text/javascript" src="js/api_page_generator.js"></script> <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/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.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"> <body> <div id="gc-container" class="labs">
<div id="devModeWarning"> <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. 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