X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib-python/blobdiff_plain/376ad06df03e59ebf0796b2f475417150e82252d..HEAD:/sig.pyx

diff --git a/sig.pyx b/sig.pyx
index f71ea48..aafa050 100644
--- a/sig.pyx
+++ b/sig.pyx
@@ -1,33 +1,36 @@
-# -*-pyrex-*-
-#
-# $Id$
-#
-# In-band signals
-#
-# (c) 2005 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### In-band signals
+###
+### (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.
 
 import signal
 
 cdef class SelSignal:
+  """
+  SelSignal(SIG, [signalledproc = None])
+
+  Collect signals from the event loop.
+  """
   cdef sig s
   cdef int _activep
   cdef readonly int signal
@@ -42,9 +45,11 @@ cdef class SelSignal:
     if me._activep:
       sig_remove(&me.s)
   property activep:
+    """SS.activep -> BOOL: is the handler still active?"""
     def __get__(me):
       return _tobool(me._activep)
   property signalledproc:
+    """SS.signalledproc -> FUNC: call FUNC() when the signal is received"""
     def __get__(me):
       return me._signalled
     def __set__(me, proc):
@@ -52,12 +57,14 @@ cdef class SelSignal:
     def __del__(me):
       me._signalled = None
   def enable(me):
+    """SS.enable(): enable the handler"""
     if me._activep:
       raise ValueError, 'already enabled'
     sig_add(&me.s, me.signal, _sigfunc, <void *>me)
     me._enabled()
     return me
   def disable(me):
+    """SS.disable(): disable the handler"""
     if not me._activep:
       raise ValueError, 'already disabled'
     sig_remove(&me.s)
@@ -70,10 +77,13 @@ cdef class SelSignal:
     me._activep = 0
     me.disabled()
   def enabled(me):
+    """SS.enabled(): called when handler is enabled"""
     pass
   def disabled(me):
+    """SS.disabled(): called when handler is disabled"""
     pass
   def signalled(me):
+    """SS.signalled(): called when the signal is received"""
     return _maybecall(me._signalled, ())
 
 cdef void _sigfunc(int sig, void *arg):
@@ -83,4 +93,4 @@ cdef void _sigfunc(int sig, void *arg):
 
 sig_init(&_sel)
 
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------