Fix warnings from Doxygen

This commit is contained in:
Andrew Johnson
2022-07-04 16:18:46 -05:00
parent 818f33e78f
commit b5105740e6
2 changed files with 7 additions and 3 deletions

View File

@@ -387,7 +387,7 @@ install directories.
EPICS executables and perl scripts are installed into the
`$(INSTALL_LOCATION)/bin/<arch>` directories. Libraries are installed
into $`(INSTALL_LOCATION)/lib/<arch>`. The default definition for
into `$(INSTALL_LOCATION)/lib/<arch>`. The default definition for
`$(INSTALL_LOCATION)` is `$(TOP)` which is the root directory in the
distribution directory structure, `base`. Intermediate object files
are stored in `O.<arch>` source subdirectories during the build

View File

@@ -84,6 +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 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.
@@ -128,14 +130,16 @@ public:
/**
* \brief Wait for and fetch the next message.
* \param message Buffer to hold message.
* \param size Bytes available in the buffer.
* \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.
*
* Waits up to \p timeout seconds for a message to arrive if the queue
* is empty, then moves the first message to the specified location.
* is empty, then moves the first message to the message buffer.
*
* If the received message is larger than the specified message size
* If the received message is larger than the buffer size
* the implementation may either return -1, or truncate the
* message. It is most efficient if the messageBufferSize is equal
* to the maximumMessageSize with which the message queue was