blob: 8502865c4e006f06c110f95b4bae74823506fbcf (
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
|
<?xml version="1.0"?>
<page id="DocExamples.Obj-signal-example"
type="topic"
style="signal"
xmlns="http://projectmallard.org/1.0/"
xmlns:api="http://projectmallard.org/experimental/api/"
xmlns:ui="http://projectmallard.org/1.0/ui/">
<info>
<link type="guide" xref="DocExamples.Obj" group="property"/>
<title type="link" role="topic">signal-example</title>
</info>
<title>DocExamples.Obj::signal-example</title>
<synopsis><code mime="text/x-csrc">
void signal-example (guint int_param,
guint float_param,
gpointer pointer_param);
</code></synopsis>
<p>This is an example of how to document a signal.</p>
<p>Since 0.99</p>
<dl>
<dt><p>int_param :</p></dt>
<dd><p>a parameter of type int</p></dd>
<dt><p>float_param :</p></dt>
<dd><p>a parameter of type float</p></dd>
<dt><p>pointer_param :</p></dt>
<dd><p>A pointer to @obj's thingy -- pass <code>int_param</code> if you really want to.</p></dd>
<dt><p>Returns :</p></dt>
<dd></dd>
</dl>
</page>
|
