summaryrefslogtreecommitdiff
path: root/tests/scanner/Regress-1.0-Python-expected/Regress.FooObject-read_fn.page
blob: 54ca4a09013a00cf9f81b5b84fea8c9faa6b755d (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
<?xml version="1.0"?>
<page id="Regress.FooObject-read_fn"
      type="topic"
      style="vfunc"
      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.FooObject" group="vfunc" type="guide"/>
  </info>
  <title>Regress.FooObject::read_fn</title>
  <synopsis><code mime="text/x-python">
@accepts(Regress.FooObject, int, int)
@returns(none)
def do_read_fn(object, offset, length):
  </code></synopsis>
  <p>Read some stuff.</p>

<terms>
<item>
<title><code>object</code></title>
  <p>obj</p>
</item>
<item>
<title><code>offset</code></title>
  <p>offset</p>
</item>
<item>
<title><code>length</code></title>
  <p>length</p>
</item>
</terms>

</page>