*.pyx: Add some rather laconic docstrings.

[mLib-python] / selpk.pyx

diff --git a/selpk.pyx b/selpk.pyx
index ee27302ce8cd754776d079d759c238b979c1a54e..a54ce95de81449cc565f9c09df26e79189f8d884 100644 (file)
--- a/selpk.pyx
+++ b/selpk.pyx
@@ -24,6 +24,11 @@
 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 cdef class SelPacketBuffer:
+  """
+  SelPacketBuffer(FILE, [packetproc = None], [eofproc = None])
+
+  Split an incoming stream into packets.
+  """
   cdef selpk p
   cdef _packet
   cdef _eof
@@ -35,12 +40,15 @@ cdef class SelPacketBuffer:
   def __dealloc__(me):
     selpk_destroy(&me.p)
   property activep:
+    """SPK.activep -> BOOL: is the buffer still active?"""
     def __get__(me):
       return _to_bool(me.p.pk.f & PKBUF_ENABLE)
   property fd:
+    """SPK.fd -> INT: the file descriptor"""
     def __get__(me):
       return me.p.reader.fd
   property want:
+    """SPK.want -> INT: size of next packet to return"""
     def __get__(me):
       return me.p.pk.want
     def __set__(me, n):
@@ -48,6 +56,7 @@ cdef class SelPacketBuffer:
         raise TypeError, 'size must be positive'
       selpk_want(&me.p, n)
   property packetproc:
+    """SPK.packetproc -> FUNC: call FUNC(PACKET) on each packet"""
     def __get__(me):
       return me._packet
     def __set__(me, proc):
@@ -55,6 +64,7 @@ cdef class SelPacketBuffer:
     def __del__(me):
       me._packet = None
   property eofproc:
+    """SPK.eofproc -> FUNC: call FUNC() at end-of-file"""
     def __get__(me):
       return me._eof
     def __set__(me, proc):
@@ -62,24 +72,30 @@ cdef class SelPacketBuffer:
     def __del__(me):
       me._eof = None
   def enable(me):
+    """SPK.enable(): enable the buffer, allowing packets to be emitted"""
     if me.p.pk.f & PKBUF_ENABLE:
       raise ValueError, 'already enabled'
     selpk_enable(&me.p)
     me.enabled()
     return me
   def disable(me):
+    """SPK.disable(): disable the buffer, suspending packet emission"""
     if not (me.p.pk.f & PKBUF_ENABLE):
       raise ValueError, 'already disabled'
     selpk_disable(&me.p)
     me.disabled()
     return me
   def enabled(me):
+    """SPK.enabled(): called when buffer is enabled"""
     pass
   def disabled(me):
+    """SPK.disabled(): called when buffer is disabled"""
     pass
   def packet(me, pk):
+    """SPK.packet(PACKET): called for each completed packet"""
     return _maybecall(me._packet, (pk,))
   def eof(me):
+    """SPK.eof(): called at end-of-file"""
     return _maybecall(me._eof, ())
 
 cdef void _selpkfunc(unsigned char *p, size_t n, pkbuf *pk,