epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Fix doc. comments in epicsEvent.h

Browse Source 
* Fix typo in epicsEventWaitWithTimeout.

* Reword epicsEvent timeout documentation to reflect the actual behavior.

Negative values of timeout are handled the same way as zero values.
Change the documentation to reflect this behavior.
This commit is contained in:
Gustavo de Souza dos Reis
2025-10-14 12:47:59 -03:00
committed by Dirk Zimoch
parent 3c7f759d86
commit a13dfac124
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
modules/libcom/src/osi/epicsEvent.h
View File

@@ -99,7 +99,7 @@ public:
**/
void wait ();
/**\brief Wait for the event or until the specified timeout.
* \param timeout The timeout delay in seconds. A timeout of zero is
* \param timeout The timeout delay in seconds. A timeout of zero or less is
* equivalent to calling tryWait(); NaN or any value too large to be
* represented to the target OS is equivalent to no timeout.
* \return True if the event was triggered, False if it timed out.
@@ -189,10 +189,10 @@ LIBCOM_API epicsEventStatus epicsEventWait(
*/
LIBCOM_API void epicsEventMustWait(epicsEventId id);
/**\brief Wait an the event or until the specified timeout period is over.
/**\brief Wait for the event or until the specified timeout period is over.
* \note Blocks until full or timeout.
* \param id The event identifier.
* \param timeout The timeout delay in seconds. A timeout of zero is
* \param timeout The timeout delay in seconds. A timeout of zero or less is
* equivalent to calling epicsEventTryWait(); NaN or any value too large
* to be represented to the target OS is equivalent to no timeout.
* \return Status indicator.