From 8ad7bc7bae775ae1292186c0cee9e2da138be54d Mon Sep 17 00:00:00 2001
From: Benny Prijono <bennylp@teluu.com>
Date: Thu, 4 Jan 2007 22:45:08 +0000
Subject: Just updated and improved the doxygen documentations all over the
 place

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@875 74dad513-b988-da41-8d7b-12977e46ad98
---
 pjmedia/include/pjmedia/conference.h | 17 +++++++++++++----
 pjmedia/include/pjmedia/session.h    |  2 +-
 pjmedia/include/pjmedia/sound.h      |  2 +-
 pjmedia/include/pjmedia/tonegen.h    |  4 ++--
 4 files changed, 17 insertions(+), 8 deletions(-)

(limited to 'pjmedia/include')

diff --git a/pjmedia/include/pjmedia/conference.h b/pjmedia/include/pjmedia/conference.h
index 0aef15c5..87de10c8 100644
--- a/pjmedia/include/pjmedia/conference.h
+++ b/pjmedia/include/pjmedia/conference.h
@@ -31,6 +31,13 @@
  * @ingroup PJMEDIA_PORT
  * @brief The implementation of conference bridge
  * @{
+ *
+ * This describes the conference bridge implementation in PJMEDIA. The
+ * conference bridge provides powerful and very efficient mechanism to
+ * route the audio flow and mix the audio signal when required.
+ *
+ * Some more information about the media flow when conference bridge is
+ * used is described in http://www.pjsip.org/trac/wiki/media-flow .
  */
 
 PJ_BEGIN_DECL
@@ -97,11 +104,13 @@ enum pjmedia_conf_option
  * be created in the conference bridge. Application MUST acquire the port
  * interface of the bridge by calling #pjmedia_conf_get_master_port(), and
  * connect this port interface to a sound device port by calling
- * #pjmedia_snd_port_connect().
+ * #pjmedia_snd_port_connect(), or to a master port (pjmedia_master_port)
+ * if application doesn't want to instantiate any sound devices.
  *
- * The sound device is crucial for the bridge's operation, because it provides
- * the bridge with necessary clock to process the audio frames periodically.
- * Internally, the bridge runs when get_frame() to port zero is called.
+ * The sound device or master port are crucial for the bridge's operation, 
+ * because it provides the bridge with necessary clock to process the audio
+ * frames periodically. Internally, the bridge runs when get_frame() to 
+ * port zero is called.
  *
  * @param pool		    Pool to use to allocate the bridge and 
  *			    additional buffers for the sound device.
diff --git a/pjmedia/include/pjmedia/session.h b/pjmedia/include/pjmedia/session.h
index b76e4de4..e6f0d2d8 100644
--- a/pjmedia/include/pjmedia/session.h
+++ b/pjmedia/include/pjmedia/session.h
@@ -280,7 +280,7 @@ PJ_DECL(pj_status_t) pjmedia_session_get_stream_stat(pjmedia_session *session,
  *
  * @param session	The media session.
  * @param index		The stream index.
- * @param ascii_digits	String of ASCII digits (i.e. 0-9*#A-B).
+ * @param ascii_digits	String of ASCII digits (i.e. 0-9*##A-B).
  *
  * @return		PJ_SUCCESS on success.
  */
diff --git a/pjmedia/include/pjmedia/sound.h b/pjmedia/include/pjmedia/sound.h
index 39c71b92..b164c53a 100644
--- a/pjmedia/include/pjmedia/sound.h
+++ b/pjmedia/include/pjmedia/sound.h
@@ -253,7 +253,7 @@ PJ_DECL(pj_status_t) pjmedia_snd_open_player( int index,
  * Get information about live stream.
  *
  * @param strm		The stream to be queried.
- * @param i		Pointer to stream information to be filled up with
+ * @param pi		Pointer to stream information to be filled up with
  *			information about the stream.
  *
  * @return		PJ_SUCCESS on success or the appropriate error code.
diff --git a/pjmedia/include/pjmedia/tonegen.h b/pjmedia/include/pjmedia/tonegen.h
index 5d232a4c..21a4f063 100644
--- a/pjmedia/include/pjmedia/tonegen.h
+++ b/pjmedia/include/pjmedia/tonegen.h
@@ -84,7 +84,7 @@ typedef struct pjmedia_tone_digit
  * This structure describes the digit map which is used by the tone generator
  * to produce tones from an ASCII digits.
  * Digit map used by a particular tone generator can be retrieved/set with
- * #pjmedia_tonegen_get_digit_map() and #pjmedia_tonegen_load_digit_map().
+ * #pjmedia_tonegen_get_digit_map() and #pjmedia_tonegen_set_digit_map().
  */
 typedef struct pjmedia_tone_digit_map
 {
@@ -94,7 +94,7 @@ typedef struct pjmedia_tone_digit_map
 	char    digit;	    /**< The ASCI identification for the digit.	*/
 	short   freq1;	    /**< First frequency.			*/
 	short   freq2;	    /**< Optional second frequency.		*/
-    } digits[16];
+    } digits[16];	    /**< Array of digits in the digit map.	*/
 } pjmedia_tone_digit_map;
 
 
-- 
cgit v1.2.3