summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 7ac8fa5)
raw | patch | inline | side by side (parent: 7ac8fa5)
author | Ramsey Harris <ramsey@ti.com> | |
Mon, 16 Mar 2015 16:22:30 +0000 (09:22 -0700) | ||
committer | Robert Tivy <rtivy@ti.com> | |
Tue, 17 Mar 2015 23:15:54 +0000 (16:15 -0700) |
Replace the incorrect remoteProcId argument with procId in the
doxygen description. Fix macro spelling error. Minor word smithing.
doxygen description. Fix macro spelling error. Minor word smithing.
packages/ti/ipc/MessageQ.h | patch | blob | history |
index 8efaa2c310c3711d01cd3788e5998222e76d7651..e1a030bce92fe8a3dc9b1b8c9a9dbcdbc7c20e30 100644 (file)
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
* MessageQ_Params params;
*
* MessageQ_Params_init(¶ms);
- * params.queueIndex = SERVER_QIDX;
- * messageQ = MessageQ_create("server", ¶ms);
+ * params.queueIndex = SERVER_QUEIDX;
+ * messageQ = MessageQ_create(NULL, ¶ms);
* ...
* }
*
* 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