diff options
author | Leif Madsen <leif@leifmadsen.com> | 2010-06-08 14:38:18 +0000 |
---|---|---|
committer | Leif Madsen <leif@leifmadsen.com> | 2010-06-08 14:38:18 +0000 |
commit | c672763af85368f36138a8a2b3c0e60537845c20 (patch) | |
tree | 64c655c3bd700fc37317b092c146c7fe412b6fbd /include/asterisk/astobj2.h | |
parent | 523e4e50bf0a61d113c6cba99127c85c64f3ab2c (diff) |
Fix some doxygen warnings.
(closes issue #17336)
Reported by: snuffy
Patches:
doxygen-fixes1.diff uploaded by snuffy (license 35)
Tested by: russell
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@268969 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/astobj2.h')
-rw-r--r-- | include/asterisk/astobj2.h | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h index 323acb4cf..172407b80 100644 --- a/include/asterisk/astobj2.h +++ b/include/asterisk/astobj2.h @@ -431,6 +431,7 @@ void *__ao2_alloc(const size_t data_size, ao2_destructor_fn destructor_fn); * * \param o A pointer to the object * \param delta Value to add to the reference counter. + * \param tag used for debugging * \return The value of the reference counter before the operation. * * Increase/decrease the reference counter according @@ -695,13 +696,15 @@ struct ao2_container; * We allocate space for a struct astobj_container, struct container * and the buckets[] array. * - * \param n_buckets Number of buckets for hash - * \param hash_fn Pointer to a function computing a hash value. - * \param cmp_fn Pointer to a function comparating key-value + * \param arg1 Number of buckets for hash + * \param arg2 Pointer to a function computing a hash value. + * \param arg3 Pointer to a function comparating key-value * with a string. (can be NULL) + * \param arg4 + * * \return A pointer to a struct container. * - * destructor is set implicitly. + * \note Destructor is set implicitly. */ #if defined(REF_DEBUG) @@ -746,10 +749,11 @@ int ao2_container_count(struct ao2_container *c); /*! * \brief Add an object to a container. * - * \param c the container to operate on. - * \param newobj the object to be added. + * \param arg1 the container to operate on. + * \param arg2 the object to be added. + * \param arg3 used for debuging. * - * \retval NULL on errors + * \retval NULL on errors. * \retval newobj on success. * * This function inserts an object in a container according its key. @@ -777,8 +781,9 @@ void *__ao2_link(struct ao2_container *c, void *newobj); /*! * \brief Remove an object from a container * - * \param c the container - * \param obj the object to unlink + * \param arg1 the container + * \param arg2 the object to unlink + * \param arg3 tag for debugging * * \retval NULL, always * @@ -837,6 +842,7 @@ void *__ao2_unlink(struct ao2_container *c, void *obj); flags is the same as flags passed into ao2_callback (flags are also used by ao2_callback). * \param arg passed to the callback. + * \param tag used for debuging. * \return when OBJ_MULTIPLE is not included in the flags parameter, * the return value will be either the object found or NULL if no * no matching object was found. if OBJ_MULTIPLE is included, |