summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTatsuhiro Tsujikawa <tatsuhiro.t@gmail.com>2013-05-23 21:18:54 +0900
committerTatsuhiro Tsujikawa <tatsuhiro.t@gmail.com>2013-05-23 21:18:54 +0900
commit6c0fa43fa583ad41a31a0191de6783cb856da55b (patch)
tree78e9141472a99b08b30a6dd249dcb018546b96d1 /src
parentdb1106101d16178bddc67ff917a970eea69a3866 (diff)
Update doc
Diffstat (limited to 'src')
-rw-r--r--src/includes/aria2/aria2.h11
1 files 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);