From 699dd0ca9d23d69771c47002b478f7df1c50ceff Mon Sep 17 00:00:00 2001 From: Michael Jerris Date: Mon, 26 May 2008 17:08:39 +0000 Subject: [PATCH] doxygen tweaks git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@8664 d0543943-73ff-0310-b7d9-9358b9ac24b2 --- src/include/switch_core.h | 10 +++++----- src/include/switch_ivr.h | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/include/switch_core.h b/src/include/switch_core.h index 5f6e7cfe51..76596037ed 100644 --- a/src/include/switch_core.h +++ b/src/include/switch_core.h @@ -732,7 +732,7 @@ SWITCH_DECLARE(void) switch_core_service_session(_In_ switch_core_session_t *ses /*! \brief Request an outgoing session spawned from an existing session using a desired endpoing module \param session the originating session - \param var_event - NEEDDESC - + \param var_event switch_event_t containing paramaters \param endpoint_name the name of the module to use for the new session \param caller_profile the originator's caller profile \param new_session a NULL pointer to aim at the newly created session @@ -822,7 +822,7 @@ SWITCH_DECLARE(uint32_t) switch_core_session_flush_private_events(switch_core_se \brief Read a frame from a session \param session the session to read from \param frame a NULL pointer to a frame to aim at the newly read frame - \param flags - NEEDDESC - + \param flags I/O flags to modify behavior (i.e. non blocking) \param stream_id which logical media channel to use \return SWITCH_STATUS_SUCCESS a the frame was read */ @@ -832,7 +832,7 @@ SWITCH_DECLARE(switch_status_t) switch_core_session_read_frame(_In_ switch_core_ \brief Read a video frame from a session \param session the session to read from \param frame a NULL pointer to a frame to aim at the newly read frame - \param flags - NEEDDESC - + \param flags I/O flags to modify behavior (i.e. non blocking) \param stream_id which logical media channel to use \return SWITCH_STATUS_SUCCESS a if the frame was read */ @@ -842,7 +842,7 @@ SWITCH_DECLARE(switch_status_t) switch_core_session_read_video_frame(_In_ switch \brief Write a video frame to a session \param session the session to write to \param frame a pointer to a frame to write - \param flags - NEEDDESC - + \param flags I/O flags to modify behavior (i.e. non blocking) \param stream_id which logical media channel to use \return SWITCH_STATUS_SUCCESS a if the frame was written */ @@ -859,7 +859,7 @@ SWITCH_DECLARE(void) switch_core_session_reset(_In_ switch_core_session_t *sessi \brief Write a frame to a session \param session the session to write to \param frame the frame to write - \param flags - NEEDDESC - + \param flags I/O flags to modify behavior (i.e. non blocking) \param stream_id which logical media channel to use \return SWITCH_STATUS_SUCCESS a the frame was written */ diff --git a/src/include/switch_ivr.h b/src/include/switch_ivr.h index a5312d75d0..c8ff5bad26 100644 --- a/src/include/switch_ivr.h +++ b/src/include/switch_ivr.h @@ -227,11 +227,11 @@ SWITCH_DECLARE(switch_status_t) switch_ivr_eavesdrop_session(switch_core_session switch_eavesdrop_flag_t flags); /*! - \brief - NEEDDESC - + \brief displace the media for a session with the audio from a file \param session the session to displace - \param file - \param limit - \param flags + \param file filename + \param limit time limit in ms + \param flags m (mux) l (loop) or r(read session instead of write session) \return SWITCH_STATUS_SUCCESS if all is well */ SWITCH_DECLARE(switch_status_t) switch_ivr_displace_session(switch_core_session_t *session, const char *file, uint32_t limit, const char *flags); @@ -239,7 +239,7 @@ SWITCH_DECLARE(switch_status_t) switch_ivr_displace_session(switch_core_session_ /*! \brief Stop displacing a session \param session the session - \param file - NEEDDESC - + \param file file name from the switch_ivr_displace_session call \return SWITCH_STATUS_SUCCESS if all is well */ SWITCH_DECLARE(switch_status_t) switch_ivr_stop_displace_session(switch_core_session_t *session, const char *file);