From eb1bafe567871c56da0faf603f38143d221da0b5 Mon Sep 17 00:00:00 2001 From: Anthony Minessale Date: Sat, 11 Nov 2006 17:36:44 +0000 Subject: [PATCH] dox git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@3313 d0543943-73ff-0310-b7d9-9358b9ac24b2 --- src/include/switch_core.h | 3 ++- src/include/switch_ivr.h | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/include/switch_core.h b/src/include/switch_core.h index d108242d90..23f11ac765 100644 --- a/src/include/switch_core.h +++ b/src/include/switch_core.h @@ -130,7 +130,7 @@ SWITCH_DECLARE(switch_status_t) switch_core_media_bug_add(switch_core_session_t 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 @@ SWITCH_DECLARE(switch_status_t) switch_core_asr_load_grammar(switch_asr_handle_t /*! \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); diff --git a/src/include/switch_ivr.h b/src/include/switch_ivr.h index c8c23973f4..3207b957cd 100644 --- a/src/include/switch_ivr.h +++ b/src/include/switch_ivr.h @@ -229,8 +229,9 @@ SWITCH_DECLARE(switch_status_t) switch_regex_match(char *target, char *expressio \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 @@ SWITCH_DECLARE(switch_status_t) switch_ivr_hold(switch_core_session_t *session); /*! \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);