Update doxygen for switch_channel_variable_first and switch_channel_variable_last

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@13227 d0543943-73ff-0310-b7d9-9358b9ac24b2

diff --git a/src/include/switch_channel.h b/src/include/switch_channel.h
index 9c35f1f19860c56185d696e96395f649de3fac94..204229719d0b071f42b4d43e208dc1f40c8f7d24 100644 (file)
--- a/src/include/switch_channel.h
+++ b/src/include/switch_channel.h
@@ -247,13 +247,16 @@ SWITCH_DECLARE(const char *) switch_channel_get_variable(switch_channel_t *chann
 SWITCH_DECLARE(switch_status_t) switch_channel_get_variables(switch_channel_t *channel, switch_event_t **event);
 
 /*!
- * Start iterating over the entries in the channel variable list.
- * @param channel the channel to intterate the variales for
- * @remark  Use switch_hash_next and switch_hash_this with this function to iterate all the channel variables
+ * \brief Start iterating over the entries in the channel variable list.
+ * \param channel the channel to iterate the variables for
+ * \remark This function locks the profile mutex, use switch_channel_variable_last to unlock
  */
 SWITCH_DECLARE(switch_event_header_t *) switch_channel_variable_first(switch_channel_t *channel);
 
-
+/*!
+ * \brief Stop iterating over channel variables. 
+ * \remark Unlocks the profile mutex initially locked in switch_channel_variable_first
+ */
 SWITCH_DECLARE(void) switch_channel_variable_last(switch_channel_t *channel);
 
 /*!