blob: fa8504185e4b7119fc30c3f643383b9a573d635e (
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
|
<%inherit file="/base.tmpl"/>
<%block name="info">
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
<title type="link" role="topic">${node.name}</title>
</%block>
<%block name="synopsis">
<synopsis><code mime="text/x-python">
def callback(${formatter.to_underscores(node.parent.name).lower()}, \
% for arg in formatter.get_parameters(node):
${arg.argname}, \
% endfor
user_param1, ...)
</code></synopsis>
</%block>
<%block name="details">
<terms>
<item>
<title><code>${formatter.to_underscores(node.parent.name).lower()}</code></title>
<p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p>
</item>
% for arg in formatter.get_parameters(node):
<item>
<title><code>${arg.argname}</code></title>
${formatter.format(node, arg.doc)}
</item>
% endfor
<title><code>user_param1</code></title>
<p>first user parameter (if any) specified with the connect() method</p>
<item>
<title><code>...</code></title>
<p>additional user parameters (if any)</p>
</item>
% if node.retval and \
node.retval.type.ctype != 'void' and \
node.retval.type.ctype is not None:
<item>
<title><code>Returns</code></title>
<p>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</p>
</item>
% endif
</terms>
</%block>
|
