[asterisk-commits] mmichelson: branch 1.6.2 r214653 - in /branches/1.6.2: ./ include/asterisk/

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Fri Aug 28 13:43:02 2009
New Revision: 214653

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=214653
Log:
Merged revisions 214650 via svnmerge from 
https://origsvn.digium.com/svn/asterisk/trunk

........
  r214650 | mmichelson | 2009-08-28 13:41:23 -0500 (Fri, 28 Aug 2009) | 3 lines
  
  Fix some incorrect documentation of sched_thread functions.
........

Modified:
    branches/1.6.2/   (props changed)
    branches/1.6.2/include/asterisk/sched.h

Propchange: branches/1.6.2/
------------------------------------------------------------------------------
Binary property 'trunk-merged' - no diff available.

Modified: branches/1.6.2/include/asterisk/sched.h
URL: http://svn.asterisk.org/svn-view/asterisk/branches/1.6.2/include/asterisk/sched.h?view=diff&rev=214653&r1=214652&r2=214653
==============================================================================
--- branches/1.6.2/include/asterisk/sched.h (original)
+++ branches/1.6.2/include/asterisk/sched.h Fri Aug 28 13:43:02 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);