Author: knhor Date: Sun Dec 3 17:04:19 2006 New Revision: 3519 Modified: freeswitch/branches/knhor/trunk/src/include/switch_ivr.h Log: dox Modified: freeswitch/branches/knhor/trunk/src/include/switch_ivr.h ============================================================================== --- freeswitch/branches/knhor/trunk/src/include/switch_ivr.h (original) +++ freeswitch/branches/knhor/trunk/src/include/switch_ivr.h Sun Dec 3 17:04:19 2006 @@ -566,15 +566,15 @@ */ SWITCH_DECLARE(switch_status_t) switch_ivr_menu_stack_free(switch_ivr_menu_t *stack); - struct switch_ivr_menu_xml_ctx; typedef struct switch_ivr_menu_xml_ctx switch_ivr_menu_xml_ctx_t; /*! *\brief Build a menu stack from an xml source + *\param xml_menu_ctx The XML menu parser context previously created by switch_ivr_menu_stack_xml_init *\param menu_stack The menu stack object that will be created for you *\param xml_menus The xml Menus source *\param xml_menu The xml Menu source of the menu to be created - *\param pool memory pool (NULL to create one) + *\param timer_name The name of a timer that should be used - in almost all cases this should be NULL *\return SWITCH_STATUS_SUCCESS if all is well */ SWITCH_DECLARE(switch_status_t) switch_ivr_menu_stack_xml_build(switch_ivr_menu_xml_ctx_t *xml_menu_ctx, @@ -583,10 +583,21 @@ switch_xml_t xml_menu, char *timer_name); +/*! + *\param xml_menu_ctx The XML menu parser context previously created by switch_ivr_menu_stack_xml_init + *\param name The xml tag name to add to the parser engine + *\param function The menu function callback that will be executed when menu digits are bound to this name + *\return SWITCH_STATUS_SUCCESS if all is well + */ SWITCH_DECLARE(switch_status_t) switch_ivr_menu_stack_xml_add_custom(switch_ivr_menu_xml_ctx_t *xml_menu_ctx, char *name, switch_ivr_menu_action_function_t *function); +/*! + *\param xml_menu_ctx A pointer of a XML menu parser context to be created + *\param pool memory pool (NULL to create one) + *\return SWITCH_STATUS_SUCCESS if all is well + */ SWITCH_DECLARE(switch_status_t) switch_ivr_menu_stack_xml_init(switch_ivr_menu_xml_ctx_t **xml_menu_ctx, switch_memory_pool_t *pool); /** @} */