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/time.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/time.h')
| -rw-r--r-- | include/asterisk/time.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/include/asterisk/time.h b/include/asterisk/time.h index 8abce667d..4b7ca00ff 100644 --- a/include/asterisk/time.h +++ b/include/asterisk/time.h @@ -57,9 +57,8 @@ int ast_tvdiff_sec(struct timeval end, struct timeval start), /*! * \brief Computes the difference (in microseconds) between two \c struct \c timeval instances. - * \param ast_tvdiff_sec - * \arg end the end of the time period - * \arg start the beginning of the time period + * \param end the end of the time period + * \param start the beginning of the time period * \return the difference in microseconds */ AST_INLINE_API( |