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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<base target="_blank"/>
<link rel="stylesheet" type="text/css" media="all"
href="../../../css/base.css" />
<link rel="stylesheet" type="text/css" media="all"
href="../../../css/apidocs.css" />
<title>Add-on SDK Documentation</title>
<style type="text/css">
body {
border: 50px solid #FFFFFF;
}
</style>
<script type="text/javascript">
function rewrite_links() {
var images = document.getElementsByTagName("img");
for (var i = 0; i < images.length; i++) {
var before = images[i].src.split("packages/")[0];
var after = images[i].src.split("/docs")[1];
images[i].src = before + after;
}
}
</script>
</head>
<body onload = "rewrite_links()">
<div id="APIsample_module_api_docs" class="module_api_docs">
<h1>APIsample</h1>
<div class="module_description"><!-- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
<h1>Title</h1>
<p>Some text here</p>
<p>This text appears between the API blocks.</p>
<p>Wooo, more text.</p>
<p>Some more text here, at the end of the file.</p>
</div>
<div class="api_reference">
<h2 class="api_header">API Reference</h2>
<div class="api_component_group">
<h3 class="api_header">Classes</h3>
<div class="api_component">
<h4 class="api_name">empty-class</h4>
<p>This class contains nothing.</p>
</div>
<div class="api_component">
<h4 class="api_name">only-one-ctor</h4>
<p>This class contains only one constructor.</p>
<div class="api_component_group">
<h5 class="api_header">Constructors</h5>
<div class="api_component">
<h6 class="api_name">one-constructor(options)</h6>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
</div>
</div>
</div>
</div>
</div>
<div class="api_component">
<h4 class="api_name">two-ctors</h4>
<p>This class contains two constructors.</p>
<div class="api_component_group">
<h5 class="api_header">Constructors</h5>
<div class="api_component">
<h6 class="api_name">one-constructor(options)</h6>
<p>The first constructor.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
</div>
</div>
</div>
<div class="api_component">
<h6 class="api_name">another-constructor(options)</h6>
<p>The second constructor.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
</div>
</div>
</div>
</div>
</div>
<div class="api_component">
<h4 class="api_name">ctor-and-method</h4>
<p>This class contains one constructor and one method.</p>
<div class="api_component_group">
<h5 class="api_header">Constructors</h5>
<div class="api_component">
<h6 class="api_name">one-constructor(options)</h6>
<p>The first constructor.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
</div>
</div>
</div>
</div>
<div class="api_component_group">
<h5 class="api_header">Methods</h5>
<div class="api_component">
<h6 class="api_name">a-method(options)</h6>
<p>Does things.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An argument.</p>
</div>
</div>
</div>
</div>
</div>
<div class="api_component">
<h4 class="api_name">ctor-method-prop-event</h4>
<p>This class contains one constructor, one method, one property and an event.</p>
<div class="api_component_group">
<h5 class="api_header">Constructors</h5>
<div class="api_component">
<h6 class="api_name">one-constructor(options)</h6>
<p>The first constructor.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
</div>
</div>
</div>
</div>
<div class="api_component_group">
<h5 class="api_header">Methods</h5>
<div class="api_component">
<h6 class="api_name">a-method(options)</h6>
<p>Does things.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An argument.</p>
</div>
</div>
</div>
</div>
<div class="api_component_group">
<h5 class="api_header">Properties</h5>
<div class="api_component">
<h6 class="api_name">a-property : <span class="datatype">bool</span></h6>
<p>Represents stuff.</p>
</div>
</div>
<div class="api_component_group">
<h5 class="api_header">Events</h5>
<div class="api_component">
<h6 class="api_name">message</h6>
<p>Event emitted when the content script sends a message to the add-on.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name"><span class="datatype">JSON</span></div>
<p>The message itself as a JSON-serialized object.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="api_component_group">
<h3 class="api_header">Functions</h3>
<div class="api_component">
<h4 class="api_name">test(argOne, argTwo, argThree, options)</h4>
<p>This is a function which does nothing in particular.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">argOne : <span class="datatype">string</span></div>
<p>This is the first argument.</p>
</div>
<div class="api_component">
<div class="api_name">[ argTwo : <span class="datatype">bool</span> ]</div>
<p>This is the second argument.</p>
</div>
<div class="api_component">
<div class="api_name">[ argThree = default : <span class="datatype">uri</span> ]</div>
<p>This is the third and final argument. And this is
a test of the ability to do multiple lines of
text.</p>
</div>
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>Options Bag</p>
<div class="api_component">
<div class="api_name">[ style : <span class="datatype">string</span> ]</div>
<p>Some style information.</p>
</div>
<div class="api_component">
<div class="api_name">[ secondToLastOption = True : <span class="datatype">bool</span> ]</div>
<p>The last property.</p>
</div>
<div class="api_component">
<div class="api_name">[ lastOption : <span class="datatype">uri</span> ]</div>
<p>And this time we have
A multiline description
Written as haiku</p>
</div>
</div>
</div>
<div class="returns">Returns: <span class="datatype">object</span>
</div>
</div>
<div class="api_component">
<h4 class="api_name">append(options)</h4>
<p>This is a list of options to specify modifications to your slideBar instance.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">options</div>
<p>Pass in all of your options here.</p>
<div class="api_component">
<div class="api_name">[ icon : <span class="datatype">uri</span> ]</div>
<p>The HREF of an icon to show as the method of accessing your features slideBar</p>
</div>
<div class="api_component">
<div class="api_name">[ html : <span class="datatype">string/xml</span> ]</div>
<p>The content of the feature, either as an HTML string,
or an E4X document fragment.</p>
</div>
<div class="api_component">
<div class="api_name">[ url : <span class="datatype">uri</span> ]</div>
<p>The url to load into the content area of the feature</p>
</div>
<div class="api_component">
<div class="api_name">[ width : <span class="datatype">int</span> ]</div>
<p>Width of the content area and the selected slide size</p>
</div>
<div class="api_component">
<div class="api_name">[ persist : <span class="datatype">bool</span> ]</div>
<p>Default slide behavior when being selected as follows:
If true: blah; If false: double blah.</p>
</div>
<div class="api_component">
<div class="api_name">[ autoReload : <span class="datatype">bool</span> ]</div>
<p>Automatically reload content on select</p>
</div>
<div class="api_component">
<div class="api_name">[ onClick : <span class="datatype">function</span> ]</div>
<p>Callback when the icon is clicked</p>
</div>
<div class="api_component">
<div class="api_name">[ onSelect : <span class="datatype">function</span> ]</div>
<p>Callback when the feature is selected</p>
</div>
<div class="api_component">
<div class="api_name">[ onReady : <span class="datatype">function</span> ]</div>
<p>Callback when featured is loaded</p>
</div>
</div>
</div>
</div>
<div class="api_component">
<h4 class="api_name">cool-func.dot(howMuch, double, options, onemore, options2)</h4>
<div class="parameter_set">
<div class="api_component">
<div class="api_name">howMuch : <span class="datatype">string</span></div>
<p>How much cool it is.</p>
</div>
<div class="api_component">
<div class="api_name">[ double = true : <span class="datatype">bool</span> ]</div>
<p>In case you just really need to double it.</p>
</div>
<div class="api_component">
<div class="api_name">[ options ]</div>
<p>An object-bag of goodies.</p>
<div class="api_component">
<div class="api_name">callback : <span class="datatype">function</span></div>
<p>The callback</p>
</div>
<div class="api_component">
<div class="api_name">[ random : <span class="datatype">bool</span> ]</div>
<p>Do something random?</p>
</div>
</div>
<div class="api_component">
<div class="api_name">[ onemore : <span class="datatype">bool</span> ]</div>
<p>One more paramater</p>
</div>
<div class="api_component">
<div class="api_name">[ options2 ]</div>
<p>This is a full description of something
that really sucks. Because I now have a multiline
description of this thingy.</p>
<div class="api_component">
<div class="api_name">monkey : <span class="datatype">string</span></div>
<p>You heard me right</p>
</div>
<div class="api_component">
<div class="api_name">[ freak = true : <span class="datatype">bool</span> ]</div>
<p>Yes, you are a freak.</p>
</div>
</div>
</div>
<div class="returns">Returns: <span class="datatype">string</span><p>A value telling you just how cool you are.
A boa-constructor!
This description can go on for a while, and can even contain
some <strong>realy</strong> fancy things. Like <code>code</code>, or even
~~~~{.javascript}
// Some code!
~~~~</p>
</div>
</div>
<div class="api_component">
<h4 class="api_name">random()</h4>
<p>A function that returns a random integer between 0 and 10.</p>
<div class="returns">Returns: <span class="datatype">int</span><p>The random number.</p>
</div>
</div>
</div>
<div class="api_component_group">
<h3 class="api_header">Events</h3>
<div class="api_component">
<h4 class="api_name">open</h4>
<p>A module-level event called open.</p>
<div class="parameter_set">
<div class="api_component">
<div class="api_name"><span class="datatype">bool</span></div>
<p>Yes, it's open.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
