diff options
| author | Richard Mudgett <rmudgett@digium.com> | 2013-05-06 17:15:20 +0000 |
|---|---|---|
| committer | Richard Mudgett <rmudgett@digium.com> | 2013-05-06 17:15:20 +0000 |
| commit | 1beb86ddf5fa2f9189a0002e7dbe49fee98df719 (patch) | |
| tree | c32a86b5fbd2646330150b189132b72cd4688418 /include/asterisk/astobj2.h | |
| parent | cc855cf9d8c42c1e0a6848ca2630e2e8a12642b4 (diff) | |
Update ao2_destructor_fn doxygen.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387741 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/astobj2.h')
| -rw-r--r-- | include/asterisk/astobj2.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h index bc7a9f90f..70a9041c3 100644 --- a/include/asterisk/astobj2.h +++ b/include/asterisk/astobj2.h @@ -383,12 +383,19 @@ murf -/*! \brief - * Typedef for an object destructor. This is called just before freeing - * the memory for the object. It is passed a pointer to the user-defined - * data of the object. +/*! + * \brief Typedef for an object destructor. + * + * \param vdoomed Object to destroy. + * + * \details + * This is called just before freeing the memory for the object. + * It is passed a pointer to the user-defined data of the + * object. + * + * \return Nothing */ -typedef void (*ao2_destructor_fn)(void *); +typedef void (*ao2_destructor_fn)(void *vdoomed); /*! \brief Options available when allocating an ao2 object. */ enum ao2_alloc_opts { |