summaryrefslogtreecommitdiffstats
path: root/chrome/common
diff options
context:
space:
mode:
authorrafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2009-11-12 22:01:24 +0000
committerrafaelw@chromium.org <rafaelw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2009-11-12 22:01:24 +0000
commit7c00ba3ec3068fddc0b886401b96efd9a2c65f8b (patch)
tree586d772f9c9b7d598686485756cb7ee335b68793 /chrome/common
parent95a46221f3add0338d0f5c53b92ef4e94b5e30e0 (diff)
downloadchromium_src-7c00ba3ec3068fddc0b886401b96efd9a2c65f8b.zip
chromium_src-7c00ba3ec3068fddc0b886401b96efd9a2c65f8b.tar.gz
chromium_src-7c00ba3ec3068fddc0b886401b96efd9a2c65f8b.tar.bz2
Render Extension Docs.
(No code changes). Includes rendered extension docs that should have been included with r31834. TBR=aa Review URL: http://codereview.chromium.org/384096 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@31836 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common')
-rw-r--r--chrome/common/extensions/docs/browserAction.html6
-rw-r--r--chrome/common/extensions/docs/devtools.html106
-rw-r--r--chrome/common/extensions/docs/extension.html252
-rw-r--r--chrome/common/extensions/docs/i18n.html146
-rw-r--r--chrome/common/extensions/docs/pageAction.html6
-rw-r--r--chrome/common/extensions/docs/tabs.html92
6 files changed, 278 insertions, 330 deletions
diff --git a/chrome/common/extensions/docs/browserAction.html b/chrome/common/extensions/docs/browserAction.html
index ab272b8..351a6b9 100644
--- a/chrome/common/extensions/docs/browserAction.html
+++ b/chrome/common/extensions/docs/browserAction.html
@@ -858,7 +858,7 @@ using the <b>popup</b> field of <b>browser_action</b>.
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>ImageData</span>
</span>
</span>
)
@@ -872,9 +872,9 @@ using the <b>popup</b> field of <b>browser_action</b>.
<dd>Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<dl>
- <div>
+ <div style="display: none; ">
<div>
</div>
</div>
diff --git a/chrome/common/extensions/docs/devtools.html b/chrome/common/extensions/docs/devtools.html
index 5896628..bb9c2a4 100644
--- a/chrome/common/extensions/docs/devtools.html
+++ b/chrome/common/extensions/docs/devtools.html
@@ -184,8 +184,8 @@
<li>
<a href="#methods">Methods</a>
<ol>
- <li>
- <a href="#method-getTabEvents">getTabEvents</a>
+ <li style="display: none; ">
+ <a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
@@ -244,65 +244,27 @@
<h3>Methods</h3>
<!-- iterates over all functions -->
- <div class="apiItem">
- <a name="method-getTabEvents"></a> <!-- method-anchor -->
- <h4>getTabEvents</h4>
+ <div class="apiItem" style="display: none; ">
+ <a></a> <!-- method-anchor -->
+ <h4>method name</h4>
- <div class="summary"><span>object</span>
+ <div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.devtools.getTabEvents</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
- <var><span>tab_id</span></var></span>)</div>
+ <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
+ <var><span></span></var></span>)</div>
<div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>EXPERIMENTAL support for timeline API</p>
+ <p class="todo">Undocumented.</p>
+ <p>
+ A description from the json schema def of the function goes here.
+ </p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
- <dt>
- <var>tab_id</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>integer</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <dd style="display: none; ">
- Description of this parameter from the json schema.
- </dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>
@@ -311,50 +273,12 @@
<dl>
<div>
<div>
- <dt>
- <var style="display: none; ">paramName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>object</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>DevTools tab events object</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>
<!-- CALLBACK -->
- <div style="display: none; ">
+ <div>
<div>
<h4>Callback function</h4>
<p>
diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html
index e83adff..bb5cf0a9 100644
--- a/chrome/common/extensions/docs/extension.html
+++ b/chrome/common/extensions/docs/extension.html
@@ -219,6 +219,8 @@
<a href="#types">Types</a>
<ol>
<li>
+ <a href="#type-Event">Event</a>
+ </li><li>
<a href="#type-Port">Port</a>
</li><li>
<a href="#type-MessageSender">MessageSender</a>
@@ -590,7 +592,7 @@ For details, see
<a name="method-getBackgroundPage"></a> <!-- method-anchor -->
<h4>getBackgroundPage</h4>
- <div class="summary"><span>object</span>
+ <div class="summary"><span>DOMWindow</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension.getBackgroundPage</span>(<span style="display: none; "><span>, </span><span></span>
<var><span></span></var></span>)</div>
@@ -629,7 +631,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>DOMWindow</span>
</span>
</span>
)
@@ -645,9 +647,9 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<dl>
- <div>
+ <div style="display: none; ">
<div>
</div>
</div>
@@ -683,7 +685,7 @@ For details, see
<a name="method-getExtensionTabs"></a> <!-- method-anchor -->
<h4>getExtensionTabs</h4>
- <div class="summary"><span>array of object</span>
+ <div class="summary"><span>array of DOMWindow</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension.getExtensionTabs</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span>
<var><span>windowId</span></var></span>)</div>
@@ -768,7 +770,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>DOMWindow</span>
</span>
</span></span>
</span>
@@ -824,7 +826,7 @@ For details, see
<a name="method-getToolstrips"></a> <!-- method-anchor -->
<h4>getToolstrips</h4>
- <div class="summary"><span>array of object</span>
+ <div class="summary"><span>array of DOMWindow</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension.getToolstrips</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span>
<var><span>windowId</span></var></span>)</div>
@@ -909,7 +911,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>DOMWindow</span>
</span>
</span></span>
</span>
@@ -1094,7 +1096,7 @@ For details, see
<a name="method-getViews"></a> <!-- method-anchor -->
<h4>getViews</h4>
- <div class="summary"><span>array of object</span>
+ <div class="summary"><span>array of DOMWindow</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension.getViews</span>(<span style="display: none; "><span>, </span><span></span>
<var><span></span></var></span>)</div>
@@ -1139,7 +1141,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>DOMWindow</span>
</span>
</span></span>
</span>
@@ -1849,8 +1851,8 @@ For details, see
<!-- iterates over all types -->
<div class="apiItem">
- <a name="type-Port"></a>
- <h4>Port</h4>
+ <a name="type-Event"></a>
+ <h4>Event</h4>
<div>
<dt>
@@ -1880,7 +1882,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An object which allows two way communication with other pages.</dd>
+ <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
@@ -1888,7 +1890,7 @@ For details, see
<div>
<div>
<dt>
- <var>name</var>
+ <var>addListener</var>
<em>
<!-- TYPE -->
@@ -1903,7 +1905,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>function</span>
</span>
</span>
)
@@ -1931,7 +1933,7 @@ For details, see
</div><div>
<div>
<dt>
- <var>onDisconnect</var>
+ <var>removeListener</var>
<em>
<!-- TYPE -->
@@ -1946,7 +1948,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>object</span>
+ <span>function</span>
</span>
</span>
)
@@ -1974,7 +1976,101 @@ For details, see
</div><div>
<div>
<dt>
- <var>onMessage</var>
+ <var>hasListener</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</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>function</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo">
+ Undocumented.
+ </dd>
+ <dd style="display: none; ">
+ Description of this parameter from the json schema.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>hasListeners</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</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>function</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo">
+ Undocumented.
+ </dd>
+ <dd style="display: none; ">
+ Description of this parameter from the json schema.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div>
+
+ </div><div class="apiItem">
+ <a name="type-Port"></a>
+ <h4>Port</h4>
+
+ <div>
+ <dt>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -1997,6 +2093,126 @@ For details, see
</em>
</dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>An object which allows two way communication with other pages.</dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>name</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</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>string</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo">
+ Undocumented.
+ </dd>
+ <dd style="display: none; ">
+ Description of this parameter from the json schema.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>onDisconnect</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span id="typeTemplate">
+ <span>
+ <a href="extension.html#type-Event">Event</a>
+ </span>
+ <span style="display: none; ">
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo">
+ Undocumented.
+ </dd>
+ <dd style="display: none; ">
+ Description of this parameter from the json schema.
+ </dd>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+ </div>
+ </div><div>
+ <div>
+ <dt>
+ <var>onMessage</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional" style="display: none; ">optional</span>
+ <span id="typeTemplate">
+ <span>
+ <a href="extension.html#type-Event">Event</a>
+ </span>
+ <span style="display: none; ">
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
<dd class="todo">
Undocumented.
</dd>
diff --git a/chrome/common/extensions/docs/i18n.html b/chrome/common/extensions/docs/i18n.html
index 5ee00f1..4fae7e8 100644
--- a/chrome/common/extensions/docs/i18n.html
+++ b/chrome/common/extensions/docs/i18n.html
@@ -186,8 +186,8 @@
<ol>
<li>
<a href="#method-getAcceptLanguages">getAcceptLanguages</a>
- </li><li>
- <a href="#method-getMessage">getMessage</a>
+ </li><li style="display: none; ">
+ <a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
@@ -423,105 +423,27 @@ arg2.
</div> <!-- /description -->
- </div><div class="apiItem">
- <a name="method-getMessage"></a> <!-- method-anchor -->
- <h4>getMessage</h4>
+ </div><div class="apiItem" style="display: none; ">
+ <a></a> <!-- method-anchor -->
+ <h4>method name</h4>
- <div class="summary"><span>string</span>
+ <div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.i18n.getMessage</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>messageName</span></var></span><span class="optional"><span>, </span><span>string or array of string</span>
- <var><span>substitutions</span></var></span>)</div>
+ <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
+ <var><span></span></var></span>)</div>
<div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Get a message from the extension language catalog, for a current locale.</p>
+ <p class="todo">Undocumented.</p>
+ <p>
+ A description from the json schema def of the function goes here.
+ </p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
- <dt>
- <var>messageName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>string</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>Message name from the extension catalog.</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
- </div><div>
- <div>
- <dt>
- <var>substitutions</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</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>string or array of string</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>1 - 9 substitution parameters, if the message requires any.</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>
@@ -530,50 +452,12 @@ arg2.
<dl>
<div>
<div>
- <dt>
- <var style="display: none; ">paramName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>string</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>Message localized for current locale.</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>
<!-- CALLBACK -->
- <div style="display: none; ">
+ <div>
<div>
<h4>Callback function</h4>
<p>
diff --git a/chrome/common/extensions/docs/pageAction.html b/chrome/common/extensions/docs/pageAction.html
index 42d178d..ecb0bca 100644
--- a/chrome/common/extensions/docs/pageAction.html
+++ b/chrome/common/extensions/docs/pageAction.html
@@ -586,7 +586,7 @@ follow these guidelines:</p>
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>ImageData</span>
</span>
</span>
)
@@ -600,9 +600,9 @@ follow these guidelines:</p>
<dd>Pixel data for an image. Must be an ImageData object (for example, from a canvas element).</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<dl>
- <div>
+ <div style="display: none; ">
<div>
</div>
</div>
diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html
index 39e8b67..3cac665 100644
--- a/chrome/common/extensions/docs/tabs.html
+++ b/chrome/common/extensions/docs/tabs.html
@@ -1202,7 +1202,7 @@ For example:
<a name="method-executeScript"></a> <!-- method-anchor -->
<h4>executeScript</h4>
- <div class="summary"><span>boolean</span>
+ <div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.tabs.executeScript</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span>
<var><span>tabId</span></var></span><span class="optional"><span>, </span><span>object</span>
@@ -1424,49 +1424,11 @@ For example:
</dl>
<!-- RETURNS -->
- <h4>Returns</h4>
+ <h4 style="display: none; ">Returns</h4>
<dl>
- <div>
+ <div style="display: none; ">
<div>
- <dt>
- <var style="display: none; ">paramName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>boolean</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>Whether this call is successful</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>
@@ -2033,7 +1995,7 @@ For example:
<a name="method-insertCSS"></a> <!-- method-anchor -->
<h4>insertCSS</h4>
- <div class="summary"><span>boolean</span>
+ <div class="summary"><span style="display: none; ">void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.tabs.insertCSS</span>(<span class="optional"><span style="display: none; ">, </span><span>integer</span>
<var><span>tabId</span></var></span><span class="optional"><span>, </span><span>object</span>
@@ -2255,49 +2217,11 @@ For example:
</dl>
<!-- RETURNS -->
- <h4>Returns</h4>
+ <h4 style="display: none; ">Returns</h4>
<dl>
- <div>
+ <div style="display: none; ">
<div>
- <dt>
- <var style="display: none; ">paramName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional" style="display: none; ">optional</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>boolean</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>Whether this call is successful</dd>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
- </div>
+ </div>
</div>
</dl>