From 1beb86ddf5fa2f9189a0002e7dbe49fee98df719 Mon Sep 17 00:00:00 2001 From: Richard Mudgett Date: Mon, 6 May 2013 17:15:20 +0000 Subject: Update ao2_destructor_fn doxygen. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387741 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/astobj2.h | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'include') 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 { -- cgit v1.2.3