summaryrefslogtreecommitdiff
path: root/include/asterisk/hashtab.h
diff options
context:
space:
mode:
authorSteve Murphy <murf@digium.com>2008-09-25 21:18:12 +0000
committerSteve Murphy <murf@digium.com>2008-09-25 21:18:12 +0000
commit38028fa641713f0b3bd761c4f680120763d2980a (patch)
tree29d51cd3fd88938af7fa60efc4c4cc775db31319 /include/asterisk/hashtab.h
parentf8ddaae70bbbfaacc799b85559eb462863d49bb1 (diff)
I added a little verbage to hashtab for the hashtab_destroy func.
It was pretty sparsely documented. This update fleshes out the pbx_lua module, to add the switch statements to the extensions in the extensions.lua file, as well as removing them when the module is unloaded. Many thanks to Matt Nicholson for his fine contribution! git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@144523 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/hashtab.h')
-rw-r--r--include/asterisk/hashtab.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/asterisk/hashtab.h b/include/asterisk/hashtab.h
index ed9a95e84..aa4dc59db 100644
--- a/include/asterisk/hashtab.h
+++ b/include/asterisk/hashtab.h
@@ -198,7 +198,11 @@ struct ast_hashtab * ast_hashtab_create(int initial_buckets,
/*!
* \brief This func will free the hash table and all its memory.
- * \note It doesn't touch the objects stored in it
+ * \note It doesn't touch the objects stored in it, unless you
+ * specify a destroy func; it will call that func for each
+ * object in the hashtab, remove all the objects, and then
+ * free the hashtab itself. If no destroyfunc is specified
+ * then the routine will assume you will free it yourself.
* \param tab
* \param objdestroyfunc
*/