summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/Python/vfunc.tmpl
blob: 98a309320dd7d9dfeb5efa58fe0a6ac9d26b4b48 (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
<%inherit file="/base.tmpl"/>
<%block name="synopsis">
<synopsis><code mime="text/x-python">
% if formatter.get_parameters(node):
@accepts(\
${', '.join((formatter.format_type(arg.type) for arg in formatter.get_parameters(node)))}\
)
% endif
@returns(${formatter.format_type(node.retval.type) | x})
def \
do_${node.name}(\
${', '.join((arg.argname for arg in formatter.get_parameters(node)))}\
):
</code></synopsis>
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
<terms>
% for arg in formatter.get_parameters(node):
<item>
<title><code>${arg.argname}</code></title>
${formatter.format(node, arg.doc)}
</item>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
<item>
<title><code>Returns</code></title>
${formatter.format(node, node.retval.doc)}
</item>
% endif
</terms>
% endif
</%block>