tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-signal-example.page

   1 <?xml version="1.0"?>
   2 <page id="DocExamples.Obj-signal-example"
   3       type="topic"
   4       style="signal"
   5       xmlns="http://projectmallard.org/1.0/"
   6       xmlns:ui="http://projectmallard.org/experimental/ui/">
   7   <info>
   8     <link type="guide" xref="DocExamples.Obj" group="signal"/>
   9     <title type="link" role="topic">signal-example</title>
  10   </info>
  11   <title>DocExamples.Obj::signal-example</title>
  12 <synopsis><code mime="text/x-python">
  13 def callback(obj, float_param, since, user_param1, ...)
  14 </code></synopsis>
  15 <p>This is an example of how to document a signal.</p>
  16
  17 <table>
  18 <tr>
  19 <td><p>obj :</p></td>
  20 <td><p>instance of DocExamples.Obj that is emitting the signal</p></td>
  21 </tr>
  22 <tr>
  23 <td><p>float_param :</p></td>
  24 <td><p>a parameter of type float</p></td>
  25 </tr>
  26 <tr>
  27 <td><p>since :</p></td>
  28 <td></td>
  29 </tr>
  30 <tr>
  31 <td><p>user_param1 :</p></td>
  32 <td><p>first user parameter (if any) specified with the connect() method</p></td>
  33 </tr>
  34 <tr>
  35 <td><p>... :</p></td>
  36 <td><p>additional user parameters (if any)</p></td>
  37 </tr>
  38 </table>
  39 <p>Since 0.99</p>
  40 </page>