Skip to content
Snippets Groups Projects
Commit 0553e612 authored by Richard Mudgett's avatar Richard Mudgett
Browse files

astobj2.h comment tweaks.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@356765 65c4cc65-6c06-0410-ace0-fbb531ad65f3
parent e43d123f
Branches
Tags
No related merge requests found
...@@ -396,7 +396,7 @@ typedef void (*ao2_destructor_fn)(void *); ...@@ -396,7 +396,7 @@ typedef void (*ao2_destructor_fn)(void *);
* *
* \param data_size The sizeof() of the user-defined structure. * \param data_size The sizeof() of the user-defined structure.
* \param destructor_fn The destructor function (can be NULL) * \param destructor_fn The destructor function (can be NULL)
* \param debug_msg Ao2 object debug tracing message. * \param debug_msg An ao2 object debug tracing message.
* \return A pointer to user-data. * \return A pointer to user-data.
* *
* \details * \details
...@@ -555,7 +555,7 @@ Operations on container include: ...@@ -555,7 +555,7 @@ Operations on container include:
OBJ_POINTER - if set, 'arg' is an object pointer, and a hash table OBJ_POINTER - if set, 'arg' is an object pointer, and a hash table
search will be done. If not, a traversal is done. search will be done. If not, a traversal is done.
OBJ_KEY - if set, 'arg', is a hashable item that is not an object. OBJ_KEY - if set, 'arg', is a hashable item that is not an object.
Similar to OBJ_POINTER and mutually exclusive. Similar to OBJ_POINTER and mutually exclusive.
- \b ao2_callback(c, flags, fn, arg) - \b ao2_callback(c, flags, fn, arg)
apply fn(obj, arg) to all objects in the container. apply fn(obj, arg) to all objects in the container.
...@@ -570,7 +570,7 @@ Operations on container include: ...@@ -570,7 +570,7 @@ Operations on container include:
search will be done. If not, a traversal is done through search will be done. If not, a traversal is done through
all the hash table 'buckets'.. all the hash table 'buckets'..
OBJ_KEY - if set, 'arg', is a hashable item that is not an object. OBJ_KEY - if set, 'arg', is a hashable item that is not an object.
Similar to OBJ_POINTER and mutually exclusive. Similar to OBJ_POINTER and mutually exclusive.
- fn is a func that returns int, and takes 3 args: - fn is a func that returns int, and takes 3 args:
(void *obj, void *arg, int flags); (void *obj, void *arg, int flags);
obj is an object obj is an object
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment