diff options
| author | Russell Bryant <russell@russellbryant.com> | 2008-07-02 14:50:45 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2008-07-02 14:50:45 +0000 |
| commit | 3cf77c4c7f14a24edfc62f9c34492e4a3818f3c1 (patch) | |
| tree | eedb0c832e2091d52a827669bc93e9453bd0bde2 /include/asterisk/devicestate.h | |
| parent | 097ac9803479d226537bd491cb8c9943403bd7f2 (diff) | |
Fix a bunch of places where \arg was used instead of \param. Using \arg
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
Diffstat (limited to 'include/asterisk/devicestate.h')
| -rw-r--r-- | include/asterisk/devicestate.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/asterisk/devicestate.h b/include/asterisk/devicestate.h index 69470a9f7..50e43ce14 100644 --- a/include/asterisk/devicestate.h +++ b/include/asterisk/devicestate.h @@ -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. */ |