summaryrefslogtreecommitdiff
path: root/giscanner/mallard-C-method.tmpl
blob: 47f1051fa8b6252726fd2f7311a43a6cae182d78 (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
<?xml version="1.0"?>
<page id="${namespace.name}.${node.parent.name}.${node.name}"
      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="${namespace.name}.${node.parent.name}" group="method"/>
    <api:function>
      <api:returns>
        <api:type>${node.retval.type.ctype}</api:type>
      </api:returns>
      <api:name>${node.symbol}</api:name>
      <api:arg>
        <api:type>${node.parent.ctype} *</api:type>
        <api:name>self</api:name>
      </api:arg>
% for arg in node.parameters:
% if arg.type.ctype == '<varargs>':
      <api:varargs/>
% else:
      <api:arg>
        <api:type>${arg.type.ctype}</api:type>
        <api:name>${arg.argname}</api:name>
      </api:arg>
% endif
% endfor
    </api:function>
  </info>
  <title>${node.symbol}</title>
<synopsis><code>
${node.retval.type.ctype} ${node.symbol} (${node.parent.ctype} *self\
% if len(node.parameters) == 0:
);
% else:
,
% endif
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
${' ' * (len(node.retval.type.ctype) + len(node.symbol) + 3)}\
% if arg.type.ctype == '<varargs>':
...\
% else:
${arg.type.ctype} ${arg.argname}\
% endif
% if ix == len(node.parameters) - 1:
);
% else:
,
%endif
% endfor
</code></synopsis>
${format(node.doc)}</page>