Changeset 189

Timestamp:

Feb 15, 2006 12:41:43 PM (18 years ago)

Author:

bennylp

Message:

Correct broken links in Doxygen documentation

Location:

pjproject/trunk/pjmedia

Files:

• docs/doxygen.cfg (modified) (2 diffs)
• include/pjmedia/codec.h (modified) (1 diff)
• include/pjmedia/endpoint.h (modified) (1 diff)
• include/pjmedia/sdp.h (modified) (1 diff)
• include/pjmedia/session.h (modified) (2 diffs)
• include/pjmedia/stream.h (modified) (1 diff)

pjproject/trunk/pjmedia/docs/doxygen.cfg

@@ -501 +501 @@
 # 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 
@@ -507 +507 @@
 # 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 

pjproject/trunk/pjmedia/include/pjmedia/codec.h

@@ -36 +36 @@
  * @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().
  */
 

pjproject/trunk/pjmedia/include/pjmedia/endpoint.h

@@ -35 +35 @@
  *
  * 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()).
  */
 

pjproject/trunk/pjmedia/include/pjmedia/sdp.h

@@ -33 +33 @@
  *
  * 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.

pjproject/trunk/pjmedia/include/pjmedia/session.h

@@ -45 +45 @@
  * 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.
  */
 
@@ -63 +68 @@
 
 /**
- * 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.
  *

pjproject/trunk/pjmedia/include/pjmedia/stream.h

@@ -45 +45 @@
  *  - 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.
  */