asterisk/channel.h: fix documentation for 'ast_waitfor_nandfds()'

Co-authored-by: Florent CHAUVEAU <florentch@pm.me>
(cherry picked from commit 1c1515fc214a24da3ea602b9b0482468c4729fe2)

diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index 46dc1a63889096b4991d6b8f6ae51fa989f67584..f0658220913174aecc4775fa089caef0766708d7 100644 (file)
--- 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