kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-30 10:33:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation fixups

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@103847 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Tilghman Lesher
2008-02-20 18:29:14 +00:00
parent 3dd4296de7
commit 808ae65263
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/asterisk/sched.h
View File

@@ -96,6 +96,7 @@ int ast_sched_add(struct sched_context *con, int when, ast_sched_cb callback, co
/*! /*!
* \brief replace a scheduler entry * \brief replace a scheduler entry
* \deprecated You should use the AST_SCHED_REPLACE() macro instead.
* *
* This deletes the scheduler entry for old_id if it exists, and then * This deletes the scheduler entry for old_id if it exists, and then
* calls ast_sched_add to create a new entry. A negative old_id will * calls ast_sched_add to create a new entry. A negative old_id will
@@ -123,6 +124,7 @@ int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb cal
/*! /*!
* \brief replace a scheduler entry * \brief replace a scheduler entry
* \deprecated You should use the AST_SCHED_REPLACE_VARIABLE() macro instead.
* *
* This deletes the scheduler entry for old_id if it exists, and then * This deletes the scheduler entry for old_id if it exists, and then
* calls ast_sched_add to create a new entry. A negative old_id will * calls ast_sched_add to create a new entry. A negative old_id will
@@ -134,8 +136,10 @@ int ast_sched_add_variable(struct sched_context *con, int when, ast_sched_cb cal
int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable); int ast_sched_replace_variable(int old_id, struct sched_context *con, int when, ast_sched_cb callback, const void *data, int variable);
/*! \brief Deletes a scheduled event /*! \brief Deletes a scheduled event
* Remove this event from being run. A procedure should not remove its * Remove this event from being run. A procedure should not remove its own
* own event, but return 0 instead. * event, but return 0 instead. In most cases, you should not call this
* routine directly, but use the AST_SCHED_DEL() macro instead (especially if
* you don't intend to do something different when it returns failure).
* \param con scheduling context to delete item from * \param con scheduling context to delete item from
* \param id ID of the scheduled item to delete * \param id ID of the scheduled item to delete
* \return Returns 0 on success, -1 on failure * \return Returns 0 on success, -1 on failure