From 55d4801eb0b28c92dbe256c395c95ca6faf48c95 Mon Sep 17 00:00:00 2001 From: Brendan Chandler Date: Tue, 10 May 2022 15:42:00 -0500 Subject: [PATCH] Fix a couple doxygen warnings Warnings complained about undocumented parameters. --- modules/libcom/src/osi/epicsMessageQueue.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/modules/libcom/src/osi/epicsMessageQueue.h b/modules/libcom/src/osi/epicsMessageQueue.h index 4a2925600..c477b74ff 100644 --- a/modules/libcom/src/osi/epicsMessageQueue.h +++ b/modules/libcom/src/osi/epicsMessageQueue.h @@ -84,8 +84,8 @@ public: /** * \brief Send a message or timeout. - * \param message Pointer to the data to be sent. - * \param messageSize How many bytes to send. + * \param message Pointer to the message to be sent + * \param messageSize The size of \p message * \param timeout The timeout delay in seconds. A timeout of zero is * equivalent to calling trySend(); NaN or any value too large to be * represented to the target OS is equivalent to no timeout. @@ -99,6 +99,9 @@ public: /** * \brief Try to receive a message. + * \param[out] message Output buffer to store the received message + * \param size Size of the buffer pointed to by \p message + * * If the queue holds at least one message, * the first message on the queue is moved to the specified location * and the length of that message is returned. @@ -115,6 +118,9 @@ public: /** * \brief Fetch the next message on the queue. + * \param[out] message Output buffer to store the received message + * \param size Size of the buffer pointed to by \p message + * * Wait for a message to be sent if the queue is empty, then move * the first message queued to the specified location. * @@ -130,8 +136,8 @@ public: /** * \brief Wait for and fetch the next message. - * \param message Buffer to hold message. - * \param size Bytes available in the buffer. + * \param[out] message Output buffer to store the received message + * \param size Size of the buffer pointed to by \p message * \param timeout The timeout delay in seconds. A timeout of zero is * equivalent to calling tryReceive(); NaN or any value too large to * be represented to the target OS is equivalent to no timeout.