blob: 38604e5f62da495dffebd155e41ad15f2dfd284b (
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
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta content="text/html; charset=ascii" http-equiv="Content-Type"></meta><title>Telepathy D-Bus Interface Specification</title><style type="text/css" xml:space="preserve"></style></head><body><h1 class="topbox">Telepathy D-Bus Interface Specification</h1><h2>Version 0.1.2</h2><div>Copyright (C) 2006 Collabora Limited</div><p>This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.</p><p>This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.</p><h1><a id="org.freedesktop.Telepathy.SpecAutoGenTest" name="org.freedesktop.Telepathy.SpecAutoGenTest" shape="rect"></a>org.freedesktop.Telepathy.SpecAutoGenTest</h1>
A test case for the spec processing.
<h2>Methods:</h2><div class="method"><h3>DoStuff (
b: badger, a{sv}: mushroom, s: snake
) →
a(uv)</h3><div class="docstring">
Does stuff.
</div><div><h4>Parameters</h4><dl><dt><code>badger</code> -
<code>b</code></dt><dd>A badger, which MAY be breezy.</dd><dt><code>mushroom</code> -
<code>a{sv}</code></dt><dd>Use of hallucinogenic mushrooms will lead to undefined behaviour.</dd><dt><code>snake</code> -
<code>s</code></dt><dd>A snake, it's a snake.</dd></dl></div><div><h4>Returns</h4><dl><dt><code>a(uv)</code></dt><dd>Array of structs containing whatever seems appropriate.</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.Telepathy.SpecAutoGenTest.MiscError</code></dt><dd>
Raised whenever appropriate.
<em>(generic description)</em></dd><dt><code>org.freedesktop.Telepathy.SpecAutoGenTest.OtherError</code></dt><dd>Raised if the badger or the snake eats the mushrooms</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3>StuffHappened (
ay: stoat, s: ferret, b: weasel
)</h3><div class="docstring">
Emitted when stuff happened.
</div><div><h4>Parameters</h4><dl><dt><code>stoat</code> -
<code>ay</code></dt><dd>
<em xmlns="">Mustela erminea</em>
</dd><dt><code>ferret</code> -
<code>s</code></dt><dd>
<em xmlns="">Mustela putorius furo</em>
</dd><dt><code>weasel</code> -
<code>b</code></dt><dd>
<em xmlns="">Mustela nivalis</em> (or compatible)
</dd></dl></div></div><h2>Enumerated types:</h2><h3>Adjective</h3>Adjectives which may be applied to a specification<dl xmlns=""><dt>LEVERAGING = 0</dt><dd>
Can leverage synergy
</dd><dt>SYNERGISTIC = 1</dt><dd>
Can synergize with leverage
</dd></dl><h2>Sets of flags:</h2><h3>TestFlags</h3>A set of flags<dl xmlns=""><dt><code>TEST_LOWBIT = 1</code></dt><dd>
A bit
</dd><dt><code>TEST_HIGHBIT = 128</code></dt><dd>
Another bit
</dd></dl>
<h1>Errors</h1>
<h2><a id="org.freedesktop.Telepathy.SpecAutoGenTest.MiscError" name="org.freedesktop.Telepathy.SpecAutoGenTest.MiscError" shape="rect"></a>org.freedesktop.Telepathy.SpecAutoGenTest.MiscError</h2>
Raised whenever appropriate.
<h2><a id="org.freedesktop.Telepathy.SpecAutoGenTest.OtherError" name="org.freedesktop.Telepathy.SpecAutoGenTest.OtherError" shape="rect"></a>org.freedesktop.Telepathy.SpecAutoGenTest.OtherError</h2>
Raised at all other times.
</body></html>
|
