From a13dfac124fc6b57e78ff297637ede71db02b5bb Mon Sep 17 00:00:00 2001 From: Gustavo de Souza dos Reis <52132909+gustavosr8@users.noreply.github.com> Date: Tue, 14 Oct 2025 12:47:59 -0300 Subject: [PATCH] Fix doc. comments in epicsEvent.h * 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. --- modules/libcom/src/osi/epicsEvent.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/libcom/src/osi/epicsEvent.h b/modules/libcom/src/osi/epicsEvent.h index 4fd2d338a..d69c496f9 100644 --- a/modules/libcom/src/osi/epicsEvent.h +++ b/modules/libcom/src/osi/epicsEvent.h @@ -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.