summaryrefslogtreecommitdiff
path: root/tests/scanner/Regress-1.0-Python-expected/Regress.TestObj.skip_param.page
blob: 77fc43dbc07933c6085baff637ff2401b48752ac (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?xml version="1.0"?>
<page id="Regress.TestObj.skip_param"
      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>bool</api:type>
      </api:returns>
      <api:name>regress_test_obj_skip_param</api:name>
      <api:arg>
        <api:type>Regress.TestObj</api:type>
        <api:name>self</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>a</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>out_b</api:name>
      </api:arg>
      <api:arg>
        <api:type>float</api:type>
        <api:name>c</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>inout_d</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>out_sum</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>num1</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>num2</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Regress.TestObj.skip_param</title>
  <synopsis><code mime="text/x-python">
@accepts(Regress.TestObj, int, int, float, int, int, int, int)
@returns(bool)
def skip_param(self, a, out_b, c, inout_d, out_sum, num1, num2):
    # Python wrapper for regress_test_obj_skip_param()
  </code></synopsis>
  <p>Check that a parameter is skipped</p>

<terms>
<item>
<title><code>self</code></title>
  <p>A <link xref="Regress.TestObj"/>.</p>
</item>
<item>
<title><code>a</code></title>
  <p>Parameter.</p>
</item>
<item>
<title><code>out_b</code></title>
  <p>Return value.</p>
</item>
<item>
<title><code>c</code></title>
  <p>Other parameter.</p>
</item>
<item>
<title><code>inout_d</code></title>
  <p>Will be incremented.</p>
</item>
<item>
<title><code>out_sum</code></title>
  <p>Return value.</p>
</item>
<item>
<title><code>num1</code></title>
  <p>Number.</p>
</item>
<item>
<title><code>num2</code></title>
  <p>Number.</p>
</item>
<item>
<title><code>Returns</code></title>
{formatter.format(node, node.retval.doc)}
</item>
</terms>

</page>