giscanner/mallard-Python-vfunc.tmpl

   1 <?xml version="1.0"?>
   2 <page id="${page_id}"
   3       type="topic"
   4       style="vfunc"
   5       xmlns="http://projectmallard.org/1.0/"
   6       xmlns:api="http://projectmallard.org/experimental/api/"
   7       xmlns:ui="http://projectmallard.org/experimental/ui/">
   8   <info>
   9     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/>
  10     <title type="link" role="topic">${node.name}</title>
  11   </info>
  12   <title>${namespace.name}.${node.parent.name}.${node.name}</title>
  13 <synopsis><code mime="text/x-python">
  14 % if len(node.parameters) != 0:
  15 @accepts(\
  16 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  17 ${formatter.format_type(arg.type) | x}\
  18 % if ix != len(node.parameters) - 1:
  19 , \
  20 %endif
  21 % endfor
  22 )
  23 % endif
  24 @returns(${formatter.format_type(node.retval.type) | x})
  25 def \
  26 do_${node.name}(self, \
  27 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  28 ${arg.argname}\
  29 % if ix != len(node.parameters) - 1:
  30 , \
  31 %endif
  32 % endfor
  33 ):
  34 </code></synopsis>
  35 ${formatter.format(node.doc)}
  36
  37 % if node.parameters or node.retval:
  38 <table>
  39 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  40 <tr>
  41 <td><p>${arg.argname} :</p></td>
  42 <td>${formatter.format(arg.doc)}</td>
  43 </tr>
  44 % endfor
  45 % if node.retval and node.retval.type.ctype != 'void':
  46 <tr>
  47 <td><p>Returns :</p></td>
  48 <td>${formatter.format(node.retval.doc)}</td>
  49 </tr>
  50 % endif
  51 </table>
  52 % endif
  53 % if node.version:
  54 <p>Since ${node.version}</p>
  55 % endif
  56 </page>