diff options
author | Benny Prijono <bennylp@teluu.com> | 2006-02-15 12:41:43 +0000 |
---|---|---|
committer | Benny Prijono <bennylp@teluu.com> | 2006-02-15 12:41:43 +0000 |
commit | 48f073bb278453950f1810118161ee2b640de97f (patch) | |
tree | 68171e9eb5f70743dd401644c5bfd46a72919498 | |
parent | 4c4244df083d5267fd2b80f7578559ad53af88e6 (diff) |
Correct broken links in Doxygen documentation
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@189 74dad513-b988-da41-8d7b-12977e46ad98
-rw-r--r-- | pjmedia/docs/doxygen.cfg | 4 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/codec.h | 8 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/endpoint.h | 3 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/sdp.h | 2 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/session.h | 7 | ||||
-rw-r--r-- | pjmedia/include/pjmedia/stream.h | 5 |
6 files changed, 23 insertions, 6 deletions
diff --git a/pjmedia/docs/doxygen.cfg b/pjmedia/docs/doxygen.cfg index 23f51917..9e8e36d1 100644 --- a/pjmedia/docs/doxygen.cfg +++ b/pjmedia/docs/doxygen.cfg @@ -500,13 +500,13 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a
# standard header.
-HTML_HEADER = ../pjlib/docs/header.html
+HTML_HEADER = docs/header.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER = ../pjlib/docs/footer.html
+HTML_FOOTER = docs/footer.html
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
# style sheet that is used by each HTML page. It can be used to
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. */ /** |