summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/Gjs/signal.tmpl
blob: 7c5081622cdb7c0c5c5ed492aef60aa6d06f1583 (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
<%inherit file="/base.tmpl"/>
<%block name="info">
    ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
    <title type="link" role="topic">${node.name}</title>
</%block>
<%block name="synopsis">
  <synopsis><code mime="text/x-gjs">
connect('${node.name}', function (${formatter.to_lower_camel_case(node.parent.name)}, \
% for arg in formatter.get_in_parameters(node):
% if arg.type.target_fundamental != 'none':
${arg.argname}: ${formatter.format_type(arg.type, True)}, \
% endif
% endfor
): ${formatter.format_type(node.retval.type, True)});
  </code></synopsis></%block>
<%block name="details">
<terms>
<item>
<title><code>${formatter.to_lower_camel_case(node.parent.name)}</code></title>
<p>instance of ${formatter.format_xref(node.parent)} that is emitting the signal</p>
</item>
% for arg in formatter.get_in_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' and \
     node.retval.type.ctype is not None:
<item>
<title><code>Returns</code></title>
${formatter.format(node, node.retval.doc)}
</item>
% endif
</terms>
</%block>