about summary refs log tree commit homepage
path: root/lib
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2011-02-23 16:31:16 -0800
committerEric Wong <normalperson@yhbt.net>2011-02-23 16:31:50 -0800
commit909cf19949cab04cd7c223830e93291f1d5517f5 (patch)
tree660f06c2ba8c27ac0d995adf415870f09f88a618 /lib
parentaf97f65ef9968f3f365b85e262965b5fd3c6776c (diff)
downloadruby_posix_mq-909cf19949cab04cd7c223830e93291f1d5517f5.tar.gz
Diffstat (limited to 'lib')
-rw-r--r--lib/posix_mq.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/posix_mq.rb b/lib/posix_mq.rb
index f232baa..b13bfda 100644
--- a/lib/posix_mq.rb
+++ b/lib/posix_mq.rb
@@ -1,4 +1,9 @@
 # -*- encoding: binary -*-
+#
+# This class represents an POSIX message queue descriptor (mqd_t)
+# object.  It matches the C API for POSIX messages queues closely.
+#
+# See the link:README for examples on how to use it.
 class POSIX_MQ
 
   # version of POSIX_MQ, currently 0.6.0