[Home]

Summary:ASTERISK-04038: Wrong comment for ast_sched_add
Reporter:knielsen (knielsen)Labels:
Date Opened:2005-05-02 15:17:43Date Closed:2008-01-15 15:32:59.000-0600
Priority:TrivialRegression?No
Status:Closed/CompleteComponents:Core/General
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:
Description:In sched.h, the comment for ast_sched_acc() says that the
function returns 0 on success. But it actually returns an
id that can be passed to ast_sched_del().

Disclaimer is on file.

****** ADDITIONAL INFORMATION ******

--- sched.h.~1.6.~ Fri Apr 15 13:41:04 2005
+++ sched.h Mon May  2 22:16:56 2005
@@ -62,7 +62,7 @@
 * Schedule an event to take place at some point in the future.  callback
 * will be called with data as the argument, when milliseconds into the
 * future (approximately)
- * Returns 0 on success, -1 on failure
+ * Returns ID of the scheduled item on success, -1 on failure
 */
extern int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, void *data);

Comments:By: Kevin P. Fleming (kpfleming) 2005-05-02 22:15:27

I've committed a fix to CVS, although I couldn't use your 'patch' since you didn't actually upload it... please review the bug posting guidelines about how patches should be uploaded.

Thanks!

By: Digium Subversion (svnbot) 2008-01-15 15:32:59.000-0600

Repository: asterisk
Revision: 5556

U   trunk/include/asterisk/sched.h

------------------------------------------------------------------------
r5556 | kpfleming | 2008-01-15 15:32:58 -0600 (Tue, 15 Jan 2008) | 2 lines

correct documentation for ast_sched_add (bug ASTERISK-4038)

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=5556