giscanner/mallard-Python-function.tmpl

   1 <?xml version="1.0"?>
   2 <%
   3 page_style = 'function'
   4 if node.is_constructor:
   5     page_style = 'constructor'
   6 elif node.is_method:
   7     page_style = 'method'
   8 %>
   9 <page id="${page_id}"
  10       type="topic"
  11       style="${page_style}"
  12       xmlns="http://projectmallard.org/1.0/"
  13       xmlns:api="http://projectmallard.org/experimental/api/"
  14       xmlns:ui="http://projectmallard.org/experimental/ui/">
  15   <info>
  16 % if node.parent is not None:
  17     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="${page_style}"/>
  18 % else:
  19     <link type="guide" xref="index" group="${page_style}"/>
  20 % endif
  21     <api:function>
  22       <api:returns>
  23         <api:type>${formatter.format_type(node.retval.type) | x}</api:type>
  24       </api:returns>
  25       <api:name>${node.symbol}</api:name>
  26 % if node.is_method:
  27       <api:arg>
  28         <api:type>${node.parent.ctype} *</api:type>
  29         <api:name>self</api:name>
  30       </api:arg>
  31 % endif
  32 % for arg in node.parameters:
  33 % if arg.type.ctype == '<varargs>':
  34       <api:varargs/>
  35 % else:
  36       <api:arg>
  37         <api:type>${formatter.format_type(arg.type) | x}</api:type>
  38         <api:name>${arg.argname}</api:name>
  39       </api:arg>
  40 % endif
  41 % endfor
  42     </api:function>
  43   </info>
  44   <title>${node.name}</title>
  45 <synopsis><code mime="text/x-python">
  46 % if len(node.parameters) != 0:
  47 @accepts(\
  48 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  49 ${formatter.format_type(arg.type) | x}\
  50 % if ix != len(node.parameters) - 1:
  51 , \
  52 %endif
  53 % endfor
  54 )
  55 % endif
  56 @returns(${formatter.format_type(node.retval.type) | x})
  57 def \
  58 ${node.name}(\
  59 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  60 ${arg.argname}\
  61 % if ix != len(node.parameters) - 1:
  62 , \
  63 %endif
  64 % endfor
  65 )
  66 </code></synopsis>
  67 ${formatter.format(node.doc)}
  68
  69 % if node.parameters or node.retval:
  70 <table>
  71 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
  72 <tr>
  73 <td><p>${arg.argname} :</p></td>
  74 <td>${formatter.format(arg.doc)}</td>
  75 </tr>
  76 % endfor
  77 % if node.retval and node.retval.type.ctype != 'void':
  78 <tr>
  79 <td><p>Returns :</p></td>
  80 <td>${formatter.format(node.retval.doc)}</td>
  81 </tr>
  82 % endif
  83 </table>
  84 % endif
  85 % if node.version:
  86 <p>Since ${node.version}</p>
  87 % endif
  88 </page>