summaryrefslogtreecommitdiff
path: root/tests/scanner/Regress-1.0-Python-expected/Regress.TestObj.do_matrix.page
blob: 994c3a53e9182c60a31ec445fbb0db2d6f18e3d3 (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
<?xml version="1.0"?>
<page id="Regress.TestObj.do_matrix"
      type="topic"
      style="method"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="Regress.TestObj" group="method" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>int</api:type>
      </api:returns>
      <api:name>regress_test_obj_do_matrix</api:name>
      <api:arg>
        <api:type>Regress.TestObj</api:type>
        <api:name>self</api:name>
      </api:arg>
      <api:arg>
        <api:type>unicode</api:type>
        <api:name>somestr</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Regress.TestObj.do_matrix</title>
  <synopsis><code mime="text/x-python">
@accepts(Regress.TestObj, unicode)
@returns(int)
def do_matrix(self, somestr):
    # Python wrapper for regress_test_obj_do_matrix()
  </code></synopsis>
  <p>This method is virtual.  Notably its name differs from the virtual
slot name, which makes it useful for testing bindings handle this
case.</p>

<terms>
<item>
<title><code>self</code></title>
  <p>A <link xref="Regress.TestObj"/></p>
</item>
<item>
<title><code>somestr</code></title>
  <p>Meaningless string</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>