aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b>2009-08-28 18:41:23 +0000
committermmichelson <mmichelson@f38db490-d61c-443f-a65b-d21fe96a405b>2009-08-28 18:41:23 +0000
commitfd1fa0983f1bdb501e70edd0d5350230c3b18f46 (patch)
tree847046a0447d0a80cd0a224f1b9633c1744d5bee
parent1a7c2187403db8145aff91519fe3057c437a4b92 (diff)
Fix some incorrect documentation of sched_thread functions.
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@214650 f38db490-d61c-443f-a65b-d21fe96a405b
-rw-r--r--include/asterisk/sched.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/asterisk/sched.h b/include/asterisk/sched.h
index 759672dfe..4f5fb4217 100644
--- a/include/asterisk/sched.h
+++ b/include/asterisk/sched.h
@@ -349,8 +349,8 @@ struct ast_sched_thread *ast_sched_thread_destroy(struct ast_sched_thread *st);
* \param cb the function to call when the scheduled time arrives
* \param data the parameter to pass to the scheduler callback
*
- * \retval 0 success
- * \retval non-zero failure
+ * \retval -1 Failure
+ * \retval >=0 Sched ID of added task
*/
int ast_sched_thread_add(struct ast_sched_thread *st, int when, ast_sched_cb cb,
const void *data);
@@ -369,8 +369,8 @@ int ast_sched_thread_add(struct ast_sched_thread *st, int when, ast_sched_cb cb,
* non-zero means re-schedule using the time provided when the scheduler
* entry was first created.
*
- * \retval 0 success
- * \retval non-zero failure
+ * \retval -1 Failure
+ * \retval >=0 Sched ID of added task
*/
int ast_sched_thread_add_variable(struct ast_sched_thread *st, int when, ast_sched_cb cb,
const void *data, int variable);