kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-28 07:01:07 +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

8
include/asterisk/devicestate.h
View File

@@ -204,7 +204,7 @@ struct ast_devstate_aggregate;
/*!
* \brief Initialize aggregate device state
*
* \arg agg the state object
* \param agg the state object
*
* \return nothing
*/
@@ -213,8 +213,8 @@ void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg);
/*!
* \brief Add a device state to the aggregate device state
*
* \arg agg the state object
* \arg state the state to add
* \param agg the state object
* \param state the state to add
*
* \return nothing
*/
@@ -223,7 +223,7 @@ void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_dev
/*!
* \brief Get the aggregate device state result
*
* \arg agg the state object
* \param agg the state object
*
* \return the aggregate device state after adding some number of device states.
*/