From e76332bbd6177591f798d4b6b9f294fa46c8e066 Mon Sep 17 00:00:00 2001 From: Heiko Thiery Date: Tue, 21 Apr 2020 09:26:02 +0200 Subject: [PATCH] session: add missing return value documentation Add SSH_AGAIN as return value to ssh_handle_packets documentation. Signed-off-by: Heiko Thiery Reviewed-by: Jakub Jelen --- src/session.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/session.c b/src/session.c index 3b3830f7..3199096a 100644 --- a/src/session.c +++ b/src/session.c @@ -689,7 +689,8 @@ int ssh_handle_packets(ssh_session session, int timeout) { * @param[in] fct Termination function to be used to determine if it is * possible to stop polling. * @param[in] user User parameter to be passed to fct termination function. - * @return SSH_OK on success, SSH_ERROR otherwise. + * @returns SSH_OK on success, SSH_AGAIN if timeout occurred, + * SSH_ERROR otherwise. */ int ssh_handle_packets_termination(ssh_session session, long timeout,