[asterisk-commits] russell: trunk r81999 - /trunk/include/asterisk/slinfactory.h

[SVN commits to the Asterisk project]

Author: russell
Date: Sat Sep  8 14:01:20 2007
New Revision: 81999

URL: http://svn.digium.com/view/asterisk?view=rev&rev=81999
Log:
Add doxygen documentation for slinfactory_destroy(), mainly just noting that
it doesn't free the slinfactory itself.  (This isn't related to a bug, i'm just
looking over random code)

Modified:
    trunk/include/asterisk/slinfactory.h

Modified: trunk/include/asterisk/slinfactory.h
URL: http://svn.digium.com/view/asterisk/trunk/include/asterisk/slinfactory.h?view=diff&rev=81999&r1=81998&r2=81999
==============================================================================
--- trunk/include/asterisk/slinfactory.h (original)
+++ trunk/include/asterisk/slinfactory.h Sat Sep  8 14:01:20 2007
@@ -42,7 +42,20 @@
 };
 
 void ast_slinfactory_init(struct ast_slinfactory *sf);
+
+/*!
+ * \brief Destroy the contents of a slinfactory
+ *
+ * \arg sf the slinfactory that is no longer needed
+ *
+ * This function will free any memory allocated for the contents of the
+ * slinfactory.  It does not free the slinfactory itself.  If the sf is
+ * malloc'd, then it must be explicitly free'd after calling this function.
+ *
+ * \return nothing
+ */
 void ast_slinfactory_destroy(struct ast_slinfactory *sf);
+
 int ast_slinfactory_feed(struct ast_slinfactory *sf, struct ast_frame *f);
 int ast_slinfactory_read(struct ast_slinfactory *sf, short *buf, size_t samples);
 unsigned int ast_slinfactory_available(const struct ast_slinfactory *sf);