From 6ef4a2d008d616d30bebe9642b817f261d78d01a Mon Sep 17 00:00:00 2001 From: Norm Harrison Date: Mon, 3 Apr 2023 22:39:09 -0500 Subject: [PATCH] asterisk/channel.h: fix documentation for 'ast_waitfor_nandfds()' Co-authored-by: Florent CHAUVEAU --- include/asterisk/channel.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index 46dc1a6388..f065822091 100644 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -2035,10 +2035,12 @@ int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(voi * \param nfds the number of fds to wait upon * \param exception exception flag * \param outfd fd that had activity on it - * \param ms how long the wait was + * \param ms On invocation, max wait time. Upon returning, how long the wait + * actually was (in/out parameter). * \details * Big momma function here. Wait for activity on any of the n channels, or any of the nfds - * file descriptors. + * file descriptors. -1 can be passed as the ms timeout to wait forever, 0 to + * return instantly if theres no activity immediantely available. * \return Returns the channel with activity, or NULL on error or if an FD * came first. If the FD came first, it will be returned in outfd, otherwise, outfd * will be -1