Author: anthm Date: Sat Nov 11 12:36:44 2006 New Revision: 3313 Modified: freeswitch/trunk/src/include/switch_core.h freeswitch/trunk/src/include/switch_ivr.h Log: dox Modified: freeswitch/trunk/src/include/switch_core.h ============================================================================== --- freeswitch/trunk/src/include/switch_core.h (original) +++ freeswitch/trunk/src/include/switch_core.h Sat Nov 11 12:36:44 2006 @@ -130,7 +130,7 @@ switch_media_bug_t **new_bug); /*! \brief Obtain private data from a media bug - \param session the session to obtain the private data from + \param bug the bug to get the data from \return the private data */ SWITCH_DECLARE(void *) switch_core_media_bug_get_user_data(switch_media_bug_t *bug); @@ -1205,6 +1205,7 @@ /*! \brief Unload a grammar from an asr handle \param ah the handle to unload the grammar from + \param grammar the grammar to unload \return SWITCH_STATUS_SUCCESS */ SWITCH_DECLARE(switch_status_t) switch_core_asr_unload_grammar(switch_asr_handle_t *ah, char *grammar); Modified: freeswitch/trunk/src/include/switch_ivr.h ============================================================================== --- freeswitch/trunk/src/include/switch_ivr.h (original) +++ freeswitch/trunk/src/include/switch_ivr.h Sat Nov 11 12:36:44 2006 @@ -229,8 +229,9 @@ \param bad_input_audio_file file to play if the input from the user was invalid \param digit_buffer variable digits captured will be put back into (empty if capture failed) \param digit_buffer_length length of the buffer for digits (should be the same or larger than max_digits) + \param digits_regex the qualifying regex \return switch status, used to note status of channel (will still return success if digit capture failed) - \note to test for digit capture failure look for \0 in the first position of the buffer + \note to test for digit capture failure look for \\0 in the first position of the buffer */ SWITCH_DECLARE(switch_status_t) switch_play_and_get_digits(switch_core_session_t *session, unsigned int min_digits, @@ -378,7 +379,7 @@ /*! \brief Signal the session with a protocol specific unhold message. - \param uuid the uuid of the session to unhold + \param session the session to unhold \return SWITCH_STATUS_SUCCESS if all is well */ SWITCH_DECLARE(switch_status_t) switch_ivr_unhold(switch_core_session_t *session);