signal.tmpl 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <%inherit file="/base.tmpl"/>
  2. <%block name="info">
  3. ${formatter.format_xref(node.parent, type="guide", group=page_kind)}
  4. <title type="link" role="topic">${node.name}</title>
  5. </%block>
  6. <%block name="synopsis">
  7. <synopsis><code mime="text/x-gjs">
  8. connect('${node.name}', function (${formatter.to_lower_camel_case(node.parent.name)}, \
  9. % for arg in formatter.get_in_parameters(node):
  10. % if arg.type.target_fundamental != 'none':
  11. ${arg.argname}: ${formatter.format_type(arg.type, True)}, \
  12. % endif
  13. % endfor
  14. ): ${formatter.format_type(node.retval.type, True)});
  15. </code></synopsis></%block>
  16. <%block name="details">
  17. <terms>
  18. <item>
  19. <title><code>${formatter.to_lower_camel_case(node.parent.name)}</code></title>
  20. <p>instance of ${formatter.format_xref(node.parent)} that is emitting the signal</p>
  21. </item>
  22. % for arg in formatter.get_in_parameters(node):
  23. <item>
  24. <title><code>${arg.argname}</code></title>
  25. ${formatter.format(node, arg.doc)}
  26. </item>
  27. % endfor
  28. % if node.retval and \
  29. node.retval.type.ctype != 'void' and \
  30. node.retval.type.ctype is not None:
  31. <item>
  32. <title><code>Returns</code></title>
  33. ${formatter.format(node, node.retval.doc)}
  34. </item>
  35. % endif
  36. </terms>
  37. </%block>