kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-11-16 23:08:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix a bunch of places where \arg was used instead of \param. Using \arg

Browse Source 
to document arguments seems logical, and does work, but is not the best
thing to use.

\arg in doxygen is simply for creating non-nested unordered lists.  \param is
the correct tag to use to document function parameters, and will come out
better in the generated documentation.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@127401 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Russell Bryant
2008-07-02 14:50:45 +00:00
parent 097ac98034
commit 3cf77c4c7f
10 changed files with 75 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/asterisk/timing.h
View File

@@ -107,7 +107,7 @@ int ast_timer_open(void);
/*!
* \brief Close an opened timing handle
*
* \arg handle timing fd returned from timer_open()
* \param handle timing fd returned from timer_open()
*
* \return nothing
*/
@@ -116,8 +116,8 @@ void ast_timer_close(int handle);
/*!
* \brief Set the timing tick rate
*
* \arg handle timing fd returned from timer_open()
* \arg rate ticks per second, 0 turns the ticks off if needed
* \param handle timing fd returned from timer_open()
* \param rate ticks per second, 0 turns the ticks off if needed
*
* Use this function if you want the timing fd to show input at a certain
* rate. The other alternative use of a timing fd, is using the continuous
@@ -131,8 +131,8 @@ int ast_timer_set_rate(int handle, unsigned int rate);
/*!
* \brief Acknowledge a timer event
*
* \arg handle timing fd returned from timer_open()
* \arg quantity number of timer events to acknowledge
* \param handle timing fd returned from timer_open()
* \param quantity number of timer events to acknowledge
*
* \note This function should only be called if timer_get_event()
* returned AST_TIMING_EVENT_EXPIRED.
@@ -144,7 +144,7 @@ void ast_timer_ack(int handle, unsigned int quantity);
/*!
* \brief Enable continuous mode
*
* \arg handle timing fd returned from timer_open()
* \param handle timing fd returned from timer_open()
*
* Continuous mode causes poll() on the timing fd to immediately return
* always until continuous mode is disabled.
@@ -157,7 +157,7 @@ int ast_timer_enable_continuous(int handle);
/*!
* \brief Disable continuous mode
*
* \arg handle timing fd returned from timer_close()
* \param handle timing fd returned from timer_close()
*
* \retval -1 failure, with errno set
* \retval 0 success
@@ -167,7 +167,7 @@ int ast_timer_disable_continuous(int handle);
/*!
* \brief Determine timing event
*
* \arg handle timing fd returned by timer_open()
* \param handle timing fd returned by timer_open()
*
* After poll() indicates that there is input on the timing fd, this will
* be called to find out what triggered it.
@@ -179,7 +179,7 @@ enum ast_timing_event ast_timer_get_event(int handle);
/*!
* \brief Get maximum rate supported for a timing handle
*
* \arg handle timing fd returned by timer_open()
* \param handle timing fd returned by timer_open()
*
* \return maximum rate supported for timing handle
*/