Correct broken links in Doxygen documentation
git-svn-id: https://svn.pjsip.org/repos/pjproject/trunk@189 74dad513-b988-da41-8d7b-12977e46ad98
diff --git a/pjmedia/docs/doxygen.cfg b/pjmedia/docs/doxygen.cfg
index 23f5191..9e8e36d 100644
--- a/pjmedia/docs/doxygen.cfg
+++ b/pjmedia/docs/doxygen.cfg
@@ -500,13 +500,13 @@
# 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 8de288f..1da3273 100644
--- a/pjmedia/include/pjmedia/codec.h
+++ b/pjmedia/include/pjmedia/codec.h
@@ -35,6 +35,14 @@
* @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 4599a16..351d3e7 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 59ce91f..3043348 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 d3b1a23..4d36762 100644
--- a/pjmedia/include/pjmedia/session.h
+++ b/pjmedia/include/pjmedia/session.h
@@ -44,6 +44,11 @@
*
* 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 @@
/**
- * 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 69d3c1d..5f61bd6 100644
--- a/pjmedia/include/pjmedia/stream.h
+++ b/pjmedia/include/pjmedia/stream.h
@@ -44,6 +44,11 @@
* 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.
*/
/**