From 6c0fa43fa583ad41a31a0191de6783cb856da55b Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Thu, 23 May 2013 21:18:54 +0900 Subject: [PATCH] Update doc --- src/includes/aria2/aria2.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/includes/aria2/aria2.h b/src/includes/aria2/aria2.h index b4b432f1..36c630e7 100644 --- a/src/includes/aria2/aria2.h +++ b/src/includes/aria2/aria2.h @@ -242,10 +242,13 @@ enum RUN_MODE { * * If the |mode| is :c:macro:`RUN_ONCE`, this function returns after * one event polling. In the current implementation, event polling - * timeouts in 1 second, so this function returns at most 1 second. On - * return, when no downloads are left to be processed, this function - * returns 0. Otherwise, returns 1, indicating that the caller must - * call this function one or more time to complete downloads. + * timeouts in 1 second. This function also returns on each + * timeout. On return, when no downloads are left to be processed, + * this function returns 0. Otherwise, returns 1, indicating that the + * caller must call this function one or more time to complete + * downloads. + * + * In either case, this function returns negative error code on error. */ int run(Session* session, RUN_MODE mode);