summaryrefslogtreecommitdiff
path: root/include/asterisk/timing.h
diff options
context:
space:
mode:
authorJeff Peeler <jpeeler@digium.com>2009-03-09 20:58:17 +0000
committerJeff Peeler <jpeeler@digium.com>2009-03-09 20:58:17 +0000
commitbf0bb7b3859b7d24628c58f2ece35c89362094c1 (patch)
tree5205beb525fe5b6e38f83e5efe910d8a7bf1cfdc /include/asterisk/timing.h
parentdea550a29252aa6ef4f67f323d90eb29c3e8c794 (diff)
Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
Copied from my review board description: This is a continuation of the API changes documentation started for describing changes between releases. Most of the API changes were pretty simple needing only to be brought to attention via the new "Asterisk API Changes" list. However, if you see anything that needs further explanation feel free to supplement what is there. The current method of documenting is to add (in the header file): \version <ver number> <description of changes> and then to add the function to the change list in doxyref.h on the AstAPIChanges page. I also made sure all the functions that were newly added were tagged with \since 1.6.1. I think this is a good habit to start both for the historical aspect as well as for the future ability to easily add a "New Asterisk API" page. Review: http://reviewboard.digium.com/r/190/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/timing.h')
-rw-r--r--include/asterisk/timing.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/asterisk/timing.h b/include/asterisk/timing.h
index 91e1e83ea..f10557e9d 100644
--- a/include/asterisk/timing.h
+++ b/include/asterisk/timing.h
@@ -92,6 +92,7 @@ struct ast_timing_interface {
*
* \retval NULL failure
* \retval non-Null handle to be passed to ast_unregister_timing_interface() on success
+ * \since 1.6.1
*/
#define ast_register_timing_interface(i) _ast_register_timing_interface(i, ast_module_info->self)
void *_ast_register_timing_interface(struct ast_timing_interface *funcs,
@@ -105,6 +106,7 @@ void *_ast_register_timing_interface(struct ast_timing_interface *funcs,
*
* \retval 0 success
* \retval non-zero failure
+ * \since 1.6.1
*/
int ast_unregister_timing_interface(void *handle);
@@ -113,6 +115,7 @@ int ast_unregister_timing_interface(void *handle);
*
* \retval -1 error, with errno set
* \retval >=0 success
+ * \since 1.6.1
*/
int ast_timer_open(void);
@@ -122,6 +125,7 @@ int ast_timer_open(void);
* \param handle timing fd returned from timer_open()
*
* \return nothing
+ * \since 1.6.1
*/
void ast_timer_close(int handle);
@@ -137,6 +141,7 @@ void ast_timer_close(int handle);
*
* \retval -1 error, with errno set
* \retval 0 success
+ * \since 1.6.1
*/
int ast_timer_set_rate(int handle, unsigned int rate);
@@ -150,6 +155,7 @@ int ast_timer_set_rate(int handle, unsigned int rate);
* returned AST_TIMING_EVENT_EXPIRED.
*
* \return nothing
+ * \since 1.6.1
*/
void ast_timer_ack(int handle, unsigned int quantity);
@@ -163,6 +169,7 @@ void ast_timer_ack(int handle, unsigned int quantity);
*
* \retval -1 failure, with errno set
* \retval 0 success
+ * \since 1.6.1
*/
int ast_timer_enable_continuous(int handle);
@@ -173,6 +180,7 @@ int ast_timer_enable_continuous(int handle);
*
* \retval -1 failure, with errno set
* \retval 0 success
+ * \since 1.6.1
*/
int ast_timer_disable_continuous(int handle);
@@ -185,6 +193,7 @@ int ast_timer_disable_continuous(int handle);
* be called to find out what triggered it.
*
* \return which event triggered the timing fd
+ * \since 1.6.1
*/
enum ast_timer_event ast_timer_get_event(int handle);
@@ -194,6 +203,7 @@ enum ast_timer_event ast_timer_get_event(int handle);
* \param handle timing fd returned by timer_open()
*
* \return maximum rate supported for timing handle
+ * \since 1.6.1
*/
unsigned int ast_timer_get_max_rate(int handle);