[Freeswitch-svn] [commit] r8664 - freeswitch/trunk/src/include

[Freeswitch SVN]

Author: mikej
Date: Mon May 26 13:08:39 2008
New Revision: 8664

Modified:
   freeswitch/trunk/src/include/switch_core.h
   freeswitch/trunk/src/include/switch_ivr.h

Log:
doxygen tweaks

Modified: freeswitch/trunk/src/include/switch_core.h
==============================================================================
--- freeswitch/trunk/src/include/switch_core.h	(original)
+++ freeswitch/trunk/src/include/switch_core.h	Mon May 26 13:08:39 2008
@@ -732,7 +732,7 @@
 /*! 
   \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 @@
   \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 @@
   \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 @@
   \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 @@
   \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
 */

Modified: freeswitch/trunk/src/include/switch_ivr.h
==============================================================================
--- freeswitch/trunk/src/include/switch_ivr.h	(original)
+++ freeswitch/trunk/src/include/switch_ivr.h	Mon May 26 13:08:39 2008
@@ -227,11 +227,11 @@
 															 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 @@
 /*!
   \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);