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/threadstorage.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/threadstorage.h')
| -rw-r--r-- | include/asterisk/threadstorage.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/include/asterisk/threadstorage.h b/include/asterisk/threadstorage.h index 5e6b3c348..77f9428b7 100644 --- a/include/asterisk/threadstorage.h +++ b/include/asterisk/threadstorage.h @@ -75,7 +75,7 @@ void __ast_threadstorage_object_replace(void *key_old, void *key_new, size_t len /*! * \brief Define a thread storage variable * - * \arg name The name of the thread storage object + * \param name The name of the thread storage object * * This macro would be used to declare an instance of thread storage in a file. * @@ -90,11 +90,11 @@ void __ast_threadstorage_object_replace(void *key_old, void *key_new, size_t len /*! * \brief Define a thread storage variable, with custom initialization and cleanup * - * \arg name The name of the thread storage object - * \arg init This is a custom function that will be called after each thread specific + * \param name The name of the thread storage object + * \param init This is a custom function that will be called after each thread specific * object is allocated, with the allocated block of memory passed * as the argument. - * \arg cleanup This is a custom function that will be called instead of ast_free + * \param cleanup This is a custom function that will be called instead of ast_free * when the thread goes away. Note that if this is used, it *MUST* * call free on the allocated memory. * @@ -137,11 +137,11 @@ static void __init_##name(void) \ /*! * \brief Retrieve thread storage * - * \arg ts This is a pointer to the thread storage structure declared by using + * \param ts This is a pointer to the thread storage structure declared by using * the AST_THREADSTORAGE macro. If declared with * AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be * (&my_buf). - * \arg init_size This is the amount of space to be allocated the first time + * \param init_size This is the amount of space to be allocated the first time * this thread requests its data. Thus, this should be the size that the * code accessing this thread storage is assuming the size to be. * |