posix: Doxygen Enhancement Task #1

http://www.google-melange.com/gci/task/view/google/gci2012/7987220

1 files changed, 23 insertions, 3 deletions

diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h
index 56a97a0c7a..f41866bfe5 100644
--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -2,6 +2,18 @@
  * @file mqueue.h
  *
  * This file contains the definitions related to POSIX Message Queues.
+ * 
+ * The structure of the routines is identical to that of POSIX
+ * Message_queues to leave the option of having unnamed message
+ * queues at a future date.  They are currently not part of the
+ * POSIX standard but unnamed message_queues are.  This is also
+ * the reason for the apparently unnecessary tracking of
+ * the process_shared attribute.  [In addition to the fact that
+ * it would be trivial to add pshared to the mq_attr structure
+ * and have process private message queues.]
+ *
+ * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open
+ * time.
  */
 
 /*
@@ -115,6 +127,13 @@ int mq_send(
 
 #include <time.h>
 
+/**
+ *  @brief Send a Message to a Message Queue
+ * 
+ *  15.2.4 Send a Message to a Message Queue, P1003.1b-1993, p. 277
+ *
+ *  @note P1003.4b/D8, p. 45 adds mq_timedsend().
+ */
 int mq_timedsend(
   mqd_t                  mqdes,
   const char            *msg_ptr,
@@ -125,12 +144,13 @@ int mq_timedsend(
 
 #endif /* _POSIX_TIMEOUTS */
 
-/*
+/**
+ *  @brief Receive a Message From a Message Queue 
+ * 
  *  15.2.5 Receive a Message From a Message Queue, P1003.1b-1993, p. 279
  *
- *  NOTE: P1003.4b/D8, p. 45 adds mq_timedreceive().
+ *  @note P1003.4b/D8, p. 45 adds mq_timedreceive().
  */
-
 ssize_t mq_receive(
   mqd_t         mqdes,
   char         *msg_ptr,