blob: fb96a7710f3c3f7ce9c5b7e3fd249330466145f7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
<div id="container">
<a name="top"> </a>
<!-- API HEADER -->
<div id="pageHeader">
<!-- BREADCRUMB -->
<!-- TODO: Fix these hrefs -->
<div id="breadcrumbs">
<a href="../index.html">Chrome Extensions</a> >
<a href="./index.html">Reference</a> >
<a href="chrome-api-index.html">chrome.* API</a>
</div>
<div id="pageTitle">
<h1 jscontent="namespace">chrome.apiname</h1>
</div>
</div> <!-- /pageHeader -->
<div id="pageContent">
<!-- SIDENAV -->
<div id="leftNav">
<ul>
<li> Overview </li>
<li> Programmer's Guide
<ul>
<li> Getting Started </li>
<li> ... </li>
</ul>
</li>
<li> Reference
<ul>
<li> chrome.* APIs
<ul>
<li jsselect="apiModules">
<a jscontent="name" jsvalues=".href:module + '.html'">Foo</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div id="mainColumn">
<!-- TABLE OF CONTENTS -->
<div id="toc">
<p>Contents</p>
<ol>
<li>
<a href="#overview">Description</a>
<ol>
<li><a href="#overview-properties">Properties</a></li>
<li><a href="#overview-examples">Examples</a></li>
</ol>
</li>
<li>
<a href="#methods">Methods</a>
<ol>
<li jsselect="functions">
<a jscontent="name"
jsvalues=".href:'#method-' + name"
href="#method-anchor">methodName</a>
</li>
</ol>
</li>
<li>
<a href="#events">Events</a>
<ol>
<li jsselect="events">
<a jscontent="name"
jsvalues=".href:'#event-' + name"
href="#event-anchor">eventName</a>
</li>
</ol>
</li>
<!-- TODO: What do we do about structs/types? -->
<li>
<a href="#structs">TODO: Structs</a>
<ol>
<li><a href="#struct-BookmarkTreeNode"></a></li>
</ol>
</li>
</ol>
[PENDING: links to all h2s and h3s should go here -- would it be possible
to link to overview h3s, as well? if so, how should we create their
anchor/id values?]
</div>
<!-- /TABLE OF CONTENTS -->
<!-- OVERVIEW PLACEHOLDER -- THIS GET REPLACED AUTHORED CONTENT -->
<div id="overview"></div>
<!-- METHODS -->
<div class="apiGroup" id="methods">
<a name="#methods"></a>
<h2>Methods</h2>
<!-- iterates over all functions -->
<div class="apiItem" jsselect="functions">
<a jsvalues=".name:'method-' + name"></a> <!-- method-anchor -->
<h3 jscontent="name">method name</h3>
<div class="summary">void
<!-- Note: intentionally longer 80 columns -->
<span jscontent="fullName">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="typeName"></span>
<var><span jscontent="name"></span></var></span>)</div>
<div class="description">
<p class="todo" jsdisplay="!description">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description">
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div jsselect="parameters">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em>
(<span class="optional" jsdisplay="optional">optional </span><span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd jsdisplay="_propertyList">
<dl>
<div jsselect="_propertyList">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em>
(<span class="optional" jsdisplay="optional">optional </span><span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
</div>
</dl>
</dd>
</div>
</dl>
<!-- CALLBACK -->
<div jsdisplay="callbackParameters">
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter,
it should specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span jscontent="callbackSignature">Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
<dl>
<div jsselect="callbackParameters">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em>
(<span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd jsdisplay="_propertyList">
<dl>
<div jsselect="_propertyList">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em>
(<span class="optional" jsdisplay="optional">optional </span><span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
</div>
</dl>
</dd>
</div>
</dl>
</div>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div class="apiGroup" id="events">
<a name="#events"></a>
<h2 id="events">Events</h2>
<!-- iterates over all events -->
<div jsselect="events" class="apiItem" jsselect="functions">
<a jsvalues=".name:'event-' + name"></a>
<h3 jscontent="name">event name</h3>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.bookmarks.</span><span jscontent="name">onEvent</span><span class="subdued">.addListener</span>(function(<span jscontent="callSignature">Type param1, Type param2</span>) <span class="subdued">{...}</span>);
</div>
<div class="description">
<p class="todo" jsdisplay="!description">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description">
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div jsselect="parameters">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em> (<span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">Undocumented.</dd>
<dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd jsdisplay="_propertyList">
<dl>
<div jsselect="_propertyList">
<dt>
<!-- Note: intentionally longer 80 columns -->
<var jscontent="name">paramName</var><em>
(<span class="optional" jsdisplay="optional">optional </span><span jscontent="typeName">paramType</span>)</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
</div>
</dl>
</dd>
</div>
</dl>
</div> <!-- /decription -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /mainColumn -->
</div> <!-- /pageContent -->
<div id="pageFooter" -->
TBD: copyright/license goes here
</div> <!-- /pageFooter -->
</div> <!-- /container -->
|
