summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/extension.html
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/extensions/docs/extension.html
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/extensions/docs/extension.html')
-rw-r--r--chrome/common/extensions/docs/extension.html252
1 files changed, 234 insertions, 18 deletions
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>
generated by cgit v1.1 at 2025-02-01 03:48:43 +0000