debian/control: Add Build-Depends for `dh-python'.

[mLib-python] / sel-timer.pyx

diff --git a/sel-timer.pyx b/sel-timer.pyx
index 24d3d24..ebdd433 100644 (file)
--- a/sel-timer.pyx
+++ b/sel-timer.pyx
@@ -1,29 +1,27 @@
-# -*-pyrex-*-
-#
-# $Id$
-#
-# Timer selectors
-#
-# (c) 2005 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### Timer selectors
+###
+### (c) 2005 Straylight/Edgeware
+###
 
-#----- Licensing notice -----------------------------------------------------
-#
-# This file is part of the Python interface to mLib.
-#
-# mLib/Python is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# mLib/Python is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with mLib/Python; if not, write to the Free Software Foundation,
-# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+###----- Licensing notice ---------------------------------------------------
+###
+### This file is part of the Python interface to mLib.
+###
+### mLib/Python is free software; you can redistribute it and/or modify
+### it under the terms of the GNU General Public License as published by
+### the Free Software Foundation; either version 2 of the License, or
+### (at your option) any later version.
+###
+### mLib/Python is distributed in the hope that it will be useful,
+### but WITHOUT ANY WARRANTY; without even the implied warranty of
+### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+### GNU General Public License for more details.
+###
+### You should have received a copy of the GNU General Public License
+### along with mLib/Python; if not, write to the Free Software Foundation,
+### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 cdef double _tvtofloat(timeval *tv):
   return tv.tv_sec + (tv.tv_usec / 1000000)
@@ -34,6 +32,11 @@ cdef void _floattotv(timeval *tv, double t):
   tv.tv_usec = <int>(us * 1000000)
 
 cdef class SelTimer:
+  """
+  SelTimer(WHEN, [timerproc = None])
+
+  Arrange to perform some action at time WHEN.
+  """
   cdef sel_timer t
   cdef int _activep
   cdef readonly double time
@@ -49,9 +52,11 @@ cdef class SelTimer:
     if me._activep:
       sel_rmtimer(&me.t)
   property activep:
+    """ST.activep -> BOOL: is the timer active?"""
     def __get__(me):
       return _tobool(me._activep)
   property timerproc:
+    """ST.timerproc -> FUNC: call FUNC() when the timer pops"""
     def __get__(me):
       return me._timer
     def __set__(me, proc):
@@ -59,6 +64,7 @@ cdef class SelTimer:
     def __del__(me):
       me._timer = None
   def kill(me):
+    """ST.kill(): deactivate timer permanently"""
     if not me._activep:
       raise ValueError, 'already dead'
     sel_rmtimer(&me.t)
@@ -68,8 +74,10 @@ cdef class SelTimer:
     me._activep = 0
     me.dead()
   def dead(me):
+    """ST.dead(): called when timer is deactivated"""
     pass
   def timer(me, now):
+    """ST.timer(NOW): called when the timer pops"""
     return _maybecall(me._timer, ())
 
 cdef void _timerfunc(timeval *now, void *arg):
@@ -78,4 +86,4 @@ cdef void _timerfunc(timeval *now, void *arg):
   st._dead()
   st.timer(_tvtofloat(now))
 
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------