diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-02 16:59:17 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 16:59:17 -0600 |
commit | c05d75020d231aa193444a84c84d5ecaa1a4cefa (patch) | |
tree | 9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/src/msgqident.c | |
parent | score misc: Clean up Doxygen #13 (GCI 2012) (diff) | |
download | rtems-c05d75020d231aa193444a84c84d5ecaa1a4cefa.tar.bz2 |
score misc: Clean up Doxygen #14 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
http://www.google-melange.com/gci/task/view/google/gci2012/8025204
Diffstat (limited to 'cpukit/rtems/src/msgqident.c')
-rw-r--r-- | cpukit/rtems/src/msgqident.c | 27 |
1 files changed, 7 insertions, 20 deletions
diff --git a/cpukit/rtems/src/msgqident.c b/cpukit/rtems/src/msgqident.c index 6b1c9630d2..ea527e871b 100644 --- a/cpukit/rtems/src/msgqident.c +++ b/cpukit/rtems/src/msgqident.c @@ -1,7 +1,11 @@ -/* - * Message Queue Manager - * +/** + * @file * + * @brief RTEMS Message Queue Name to Id + * @ingroup ClassicMessageQueue + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -32,23 +36,6 @@ #include <rtems/rtems/options.h> #include <rtems/rtems/support.h> -/* - * rtems_message_queue_ident - * - * This directive returns the system ID associated with - * the message queue name. - * - * Input parameters: - * name - user defined message queue name - * node - node(s) to be searched - * id - pointer to message queue id - * - * Output parameters: - * *id - message queue id - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_message_queue_ident( rtems_name name, uint32_t node, |