summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/Gjs/signal.tmpl
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-01-31 23:40:20 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-02-01 19:47:42 -0500
commit7169562133632e11fb4f564211a1db1aa61bab5c (patch)
tree5046869e9d49e1178a18897a10feb8859833814c /giscanner/doctemplates/Gjs/signal.tmpl
parent3209fdf04bdff42033e1f833913c394adcaa2e67 (diff)
downloadgobject-introspection-7169562133632e11fb4f564211a1db1aa61bab5c.tar.gz
doctool: Initial import of a Gjs language that we support
Copy/pasted from Python.
Diffstat (limited to 'giscanner/doctemplates/Gjs/signal.tmpl')
-rw-r--r--giscanner/doctemplates/Gjs/signal.tmpl35
1 files changed, 35 insertions, 0 deletions
diff --git a/giscanner/doctemplates/Gjs/signal.tmpl b/giscanner/doctemplates/Gjs/signal.tmpl
new file mode 100644
index 00000000..f2eb5868
--- /dev/null
+++ b/giscanner/doctemplates/Gjs/signal.tmpl
@@ -0,0 +1,35 @@
+<%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">
+function callback(${formatter.to_underscores(node.parent.name).lower()}, \
+% for arg in node.parameters:
+${arg.argname}:${formatter.format_type(arg.type)}, \
+% endfor
+user_param1, ...):${formatter.format_type(node.retval.type)};
+</code></synopsis>
+</%block>
+<%block name="details">
+<dl>
+<dt><p>${formatter.to_underscores(node.parent.name).lower()} :</p></dt>
+<dd><p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p></dd>
+% for arg in node.parameters:
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
+% endfor
+<dt><p>user_param1 :</p></dt>
+<dd><p>first user parameter (if any) specified with the connect() method</p></dd>
+<dt><p>... :</p></dt>
+<dd><p>additional user parameters (if any)</p></dd>
+% if node.retval and \
+ node.retval.type.ctype != 'void' and \
+ node.retval.type.ctype is not None:
+<dt><p>Returns :</p></dt>
+<dd>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</dd>
+% endif
+</dl>
+</%block>
+