[svn-commits] mmichelson: trunk r214650 - /trunk/include/asterisk/sched.h

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Fri Aug 28 13:41:23 2009
New Revision: 214650

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=214650
Log:
Fix some incorrect documentation of sched_thread functions.


Modified:
    trunk/include/asterisk/sched.h

Modified: trunk/include/asterisk/sched.h
URL: http://svn.asterisk.org/svn-view/asterisk/trunk/include/asterisk/sched.h?view=diff&rev=214650&r1=214649&r2=214650
==============================================================================
--- trunk/include/asterisk/sched.h (original)
+++ trunk/include/asterisk/sched.h Fri Aug 28 13:41:23 2009
@@ -349,8 +349,8 @@
  * \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 @@
  *        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);