From 909cf19949cab04cd7c223830e93291f1d5517f5 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 23 Feb 2011 16:31:16 -0800 Subject: doc: full rdoc coverage! --- README | 2 +- lib/posix_mq.rb | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README b/README index 2b217d2..9d83f1d 100644 --- a/README +++ b/README @@ -64,7 +64,7 @@ kernel module before attempting to use POSIX message queues: kldload mqueuefs -Our API matches the C api closely, see the RDoc for full API +Our API matches the POSIX C API closely, see the RDoc for full API documentation. Here is an example of a process communicating with itself. In practice, processes that send will be different from processes that receive. 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 -- cgit v1.2.3-24-ge0c7