From: Ramsey Harris <ramsey@ti.com>
Date: Mon, 16 Mar 2015 16:22:30 +0000 (-0700)
Subject: Correct the argument name in MessageQ_openQueueId
X-Git-Tag: 3.36.00.02_eng~3
X-Git-Url: https://git.ti.com/gitweb?p=ipc%2Fipcdev.git;a=commitdiff_plain;h=809ba992aa428e68a871f0a070f6db684c100a11

Correct the argument name in MessageQ_openQueueId

Replace the incorrect remoteProcId argument with procId in the
doxygen description. Fix macro spelling error. Minor word smithing.
---

diff --git a/packages/ti/ipc/MessageQ.h b/packages/ti/ipc/MessageQ.h
index 8efaa2c..e1a030b 100644
--- a/packages/ti/ipc/MessageQ.h
+++ b/packages/ti/ipc/MessageQ.h
@@ -776,7 +776,7 @@ Int MessageQ_delete(MessageQ_Handle *handlePtr);
 Int MessageQ_open(String name, MessageQ_QueueId *queueId);
 
 /*!
- *  @brief      Opens a MessageQ given the queue index and remote processor ID
+ *  @brief      Open a MessageQ given the queue index and processor ID
  *
  *  This function can be used instead of MessageQ_open() if the queue
  *  was created with a reserved queue index. In the example below, the
@@ -791,8 +791,8 @@ Int MessageQ_open(String name, MessageQ_QueueId *queueId);
  *          MessageQ_Params params;
  *
  *          MessageQ_Params_init(&params);
- *          params.queueIndex = SERVER_QIDX;
- *          messageQ = MessageQ_create("server", &params);
+ *          params.queueIndex = SERVER_QUEIDX;
+ *          messageQ = MessageQ_create(NULL, &params);
  *          ...
  *      }
  *
@@ -807,8 +807,9 @@ Int MessageQ_open(String name, MessageQ_QueueId *queueId);
  *  opened has already been created. MessageQ_openQueueId() does not validate
  *  that the queue has been created (unlike the MessageQ_open() function).
  *
- *  @param[in] queueIndex   QueueIndex specified in MessageQ_Params
- *  @param[in] remoteProcId Multiproc_Id of where the created queue resides
+ *  @param[in] queueIndex   QueueIndex specified in MessageQ_Params when
+ *                          the message queue was created.
+ *  @param[in] procId       Multiproc_Id of where the created queue resides.
  *
  *  @return     The MessageQ_QueueId associated with the queueIndex
  *              and remoteProcId