blob: e040414f846ac298b447b6f04a242827a4925a7b (
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
|
<?xml version="1.0"?>
<page id="DocExamples.Obj.static_method"
type="topic"
style="function"
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="function"/>
<api:function>
<api:returns>
<api:type>bool</api:type>
</api:returns>
<api:name>doc_examples_obj_static_method</api:name>
<api:arg>
<api:type>int</api:type>
<api:name>out_arg</api:name>
</api:arg>
</api:function>
</info>
<title>Obj.static_method</title>
<synopsis><code mime="text/x-python">
@accepts(int)
@returns(bool)
def static_method(out_arg):
# Python wrapper for doc_examples_obj_static_method()
</code></synopsis>
<p>This is an example of a function with an out argument
and a return value.</p>
<table>
<tr>
<td><p>out_arg :</p></td>
<td><p>a pointer to int, or <code>None</code> to ignore</p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p><code>True</code> if <code>out_arg</code> is valid, <code>False</code> otherwise</p></td>
</tr>
</table>
</page>
|
