Update ao2_destructor_fn doxygen.
authorRichard Mudgett <rmudgett@digium.com>
Mon, 6 May 2013 17:15:20 +0000 (17:15 +0000)
committerRichard Mudgett <rmudgett@digium.com>
Mon, 6 May 2013 17:15:20 +0000 (17:15 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@387741 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/astobj2.h

index bc7a9f9..70a9041 100644 (file)
@@ -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 {