From 79246506e7b2dd3c67da0b1c4da13f3d66ff28e5 Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Sat, 8 Sep 2007 19:01:20 +0000 Subject: [PATCH] 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) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@81999 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/slinfactory.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/include/asterisk/slinfactory.h b/include/asterisk/slinfactory.h index 3ab42d2839..597d366bf5 100644 --- a/include/asterisk/slinfactory.h +++ b/include/asterisk/slinfactory.h @@ -42,7 +42,20 @@ struct ast_slinfactory { }; 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);