blob: 5f27f96f3b2b6a7b60ded8d43c870853eb00b921 (
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
|
<?xml version="1.0"?>
<page id="DocExamples.Obj.method"
type="topic"
style="method"
xmlns="http://projectmallard.org/1.0/"
xmlns:api="http://projectmallard.org/experimental/api/"
xmlns:ui="http://projectmallard.org/experimental/ui/">
<info>
<link type="guide" xref="DocExamples.Obj" group="method"/>
<api:function>
<api:returns>
<api:type>gboolean</api:type>
</api:returns>
<api:name>doc_examples_obj_method</api:name>
<api:arg>
<api:type>DocExamplesObj *</api:type>
<api:name>self</api:name>
</api:arg>
<api:arg>
<api:type>gint</api:type>
<api:name>first_arg</api:name>
</api:arg>
<api:arg>
<api:type>gfloat</api:type>
<api:name>second_arg</api:name>
</api:arg>
<api:arg>
<api:type>gboolean</api:type>
<api:name>boolean_arg</api:name>
</api:arg>
<api:arg>
<api:type>gpointer</api:type>
<api:name>pointer_arg</api:name>
</api:arg>
<api:arg>
<api:type>gchar*</api:type>
<api:name>string</api:name>
</api:arg>
</api:function>
</info>
<title>doc_examples_obj_method</title>
<synopsis><code mime="text/x-csrc">
gboolean doc_examples_obj_method (DocExamplesObj *self,
gint first_arg,
gfloat second_arg,
gboolean boolean_arg,
gpointer pointer_arg,
gchar* string);
</code></synopsis>
<p>This is an example of how to document a method.</p><p>You should call this on a <link xref="DocExamples.Obj">DocExamples.Obj</link> that was
created with <link xref="DocExamples.Obj.new">doc_examples_obj_new</link>.</p><p>This should be a %FALSEALARM.</p>
<table>
<tr>
<td><p>first_arg :</p></td>
<td><p>A <link xref="DocExamples.Obj">DocExamples.Obj</link>.</p></td>
</tr>
<tr>
<td><p>second_arg :</p></td>
<td><p>second argument</p></td>
</tr>
<tr>
<td><p>boolean_arg :</p></td>
<td><p>You should always pass TRUE.</p></td>
</tr>
<tr>
<td><p>pointer_arg :</p></td>
<td><p>If not NULL, do a thing.</p></td>
</tr>
<tr>
<td><p>string :</p></td>
<td><p>A NULL-terminated string.</p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p>Either FALSE or something FALSE-y.</p></td>
</tr>
</table>
<p>Since 0.99</p>
</page>
|
