From: Richard Mudgett <rmudgett@digium.com>
Date: Mon, 6 May 2013 17:15:20 +0000 (+0000)
Subject: Update ao2_destructor_fn doxygen.
X-Git-Tag: 13.0.0-beta1~1843
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1beb86ddf5fa2f9189a0002e7dbe49fee98df719;p=thirdparty%2Fasterisk.git

Update ao2_destructor_fn doxygen.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387741 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h
index bc7a9f90f6..70a9041c37 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 {