blob: 245b2586b8a11e0b46a6f817db8c8350b6ed09e7 (
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
|
<?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>bool</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>int</api:type>
<api:name>first_arg</api:name>
</api:arg>
<api:arg>
<api:type>float</api:type>
<api:name>second_arg</api:name>
</api:arg>
<api:arg>
<api:type>bool</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>unicode</api:type>
<api:name>string</api:name>
</api:arg>
</api:function>
</info>
<title>Obj.method</title>
<synopsis><code mime="text/x-python">
@accepts(int, float, bool, gpointer, unicode)
@returns(bool)
def method(self, first_arg, second_arg, boolean_arg, pointer_arg, string):
# Python wrapper for doc_examples_obj_method()
</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"/> that was
created with <link xref="DocExamples.Obj.new"/>.</p><p>This should be a %FALSEALARM.</p>
<p>Since 0.99</p>
<dl>
<dt><p>first_arg :</p></dt>
<dd><p>A <link xref="DocExamples.Obj"/>.</p></dd>
<dt><p>second_arg :</p></dt>
<dd><p>second argument</p></dd>
<dt><p>boolean_arg :</p></dt>
<dd><p>You should always pass <code>True</code>.</p></dd>
<dt><p>pointer_arg :</p></dt>
<dd><p>If not <code>None</code>, do a thing. Pass <code>self</code> if you want to sometimes. You can also pass <code>second_arg</code>, or even <code>boolean_arg</code>.</p></dd>
<dt><p>string :</p></dt>
<dd><p>A NUL-terminated string.</p></dd>
<dt><p>Returns :</p></dt>
<dd><p>Either <code>False</code> or something <code>False</code>-y.</p></dd>
</dl>
</page>
|
