summaryrefslogtreecommitdiff
path: root/pjmedia/include
diff options
context:
space:
mode:
authorBenny Prijono <bennylp@teluu.com>2006-02-15 12:41:43 +0000
committerBenny Prijono <bennylp@teluu.com>2006-02-15 12:41:43 +0000
commit48f073bb278453950f1810118161ee2b640de97f (patch)
tree68171e9eb5f70743dd401644c5bfd46a72919498 /pjmedia/include
parent4c4244df083d5267fd2b80f7578559ad53af88e6 (diff)
Correct broken links in Doxygen documentation
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@189 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjmedia/include')
-rw-r--r--pjmedia/include/pjmedia/codec.h8
-rw-r--r--pjmedia/include/pjmedia/endpoint.h3
-rw-r--r--pjmedia/include/pjmedia/sdp.h2
-rw-r--r--pjmedia/include/pjmedia/session.h7
-rw-r--r--pjmedia/include/pjmedia/stream.h5
5 files changed, 21 insertions, 4 deletions
diff --git a/pjmedia/include/pjmedia/codec.h b/pjmedia/include/pjmedia/codec.h
index 8de288ff..1da32736 100644
--- a/pjmedia/include/pjmedia/codec.h
+++ b/pjmedia/include/pjmedia/codec.h
@@ -35,6 +35,14 @@ PJ_BEGIN_DECL
* @defgroup PJMED_CODEC Codec framework.
* @ingroup PJMEDIA
* @{
+ *
+ * The codec manager is used to manage all codec capabilities in the endpoint.
+ * Library implementors can extend PJMEDIA codec capabilities by creating
+ * a codec factory for a new codec, and register the codec factory to
+ * codec manager so that the codec can be used by the rest of application.
+ *
+ * When used with media endpoint (pjmedia_endpt), application can retrieve
+ * the codec manager instance by calling #pjmedia_endpt_get_codec_mgr().
*/
diff --git a/pjmedia/include/pjmedia/endpoint.h b/pjmedia/include/pjmedia/endpoint.h
index 4599a166..351d3e7f 100644
--- a/pjmedia/include/pjmedia/endpoint.h
+++ b/pjmedia/include/pjmedia/endpoint.h
@@ -34,8 +34,7 @@
* in the endpoint and a sound device factory.
*
* A reference to media endpoint instance is required when application wants
- * to create a media session (#pj_media_session_create or
- * #pj_media_session_create_from_sdp).
+ * to create a media session (#pjmedia_session_create()).
*/
#include <pjmedia/sound.h>
diff --git a/pjmedia/include/pjmedia/sdp.h b/pjmedia/include/pjmedia/sdp.h
index 59ce91ff..3043348e 100644
--- a/pjmedia/include/pjmedia/sdp.h
+++ b/pjmedia/include/pjmedia/sdp.h
@@ -32,7 +32,7 @@
* @{
*
* The basic SDP session descriptor and elements are described in header
- * file <pre><pjmedia/sdp.h></pre>. This file contains declaration for
+ * file <b><pjmedia/sdp.h></b>. This file contains declaration for
* SDP session descriptor and SDP media descriptor, along with their
* attributes. This file also declares functions to parse SDP message.
*/
diff --git a/pjmedia/include/pjmedia/session.h b/pjmedia/include/pjmedia/session.h
index d3b1a230..4d367625 100644
--- a/pjmedia/include/pjmedia/session.h
+++ b/pjmedia/include/pjmedia/session.h
@@ -44,6 +44,11 @@ PJ_BEGIN_DECL
*
* This module provides functions to create and manage multimedia
* sessions.
+ *
+ * Application creates the media session by calling #pjmedia_session_create(),
+ * normally after it has completed negotiating both SDP offer and answer.
+ * The session creation function creates the media session (including
+ * media streams) based on the content of local and remote SDP.
*/
@@ -62,7 +67,7 @@ struct pjmedia_session_info
/**
- * Create new session offering based on the local and remote SDP.
+ * Create media session based on the local and remote SDP.
* The session will start immediately.
*
* @param endpt The PJMEDIA endpoint instance.
diff --git a/pjmedia/include/pjmedia/stream.h b/pjmedia/include/pjmedia/stream.h
index 69d3c1db..5f61bd61 100644
--- a/pjmedia/include/pjmedia/stream.h
+++ b/pjmedia/include/pjmedia/stream.h
@@ -44,6 +44,11 @@ PJ_BEGIN_DECL
* A media stream consists of two unidirectional channels:
* - encoding channel, which transmits unidirectional media to remote, and
* - decoding channel, which receives unidirectional media from remote.
+ *
+ * Application normally does not need to create the stream directly; it
+ * creates media session instead. The media session will create the media
+ * streams as necessary, according to the media descriptors that present
+ * in local and remote SDP.
*/
/**