summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Michelson <mmichelson@digium.com>2009-08-28 18:41:23 +0000
committerMark Michelson <mmichelson@digium.com>2009-08-28 18:41:23 +0000
commit27fb59b0016c02fa73f9513f13b311f76735bb09 (patch)
tree847046a0447d0a80cd0a224f1b9633c1744d5bee
parentfdd078af520cb4e53bbc07170e265ccdec4279b8 (diff)
Fix some incorrect documentation of sched_thread functions.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@214650 65c4cc65-6c06-0410-ace0-fbb531ad65f3
-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);