diff options
| author | Benny Prijono <bennylp@teluu.com> | 2006-08-24 14:25:14 +0000 |
|---|---|---|
| committer | Benny Prijono <bennylp@teluu.com> | 2006-08-24 14:25:14 +0000 |
| commit | 9cc109b6949507108721d624724ec22fc7da38de (patch) | |
| tree | 7b6418c22d68b111dd23b82db38a4992fbaee29c /pjmedia | |
| parent | 763d1e9a8ed2e44419760db370e9280426a0b617 (diff) | |
Just updated doxygen documentation
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@690 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjmedia')
| -rw-r--r-- | pjmedia/docs/doxygen.cfg | 2 | ||||
| -rw-r--r-- | pjmedia/docs/footer.html | 7 | ||||
| -rw-r--r-- | pjmedia/docs/header.html | 3 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/echo.h | 2 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/echo_port.h | 2 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/master_port.h | 2 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/port.h | 8 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/rtcp.h | 16 | ||||
| -rw-r--r-- | pjmedia/include/pjmedia/rtp.h | 2 |
9 files changed, 31 insertions, 13 deletions
diff --git a/pjmedia/docs/doxygen.cfg b/pjmedia/docs/doxygen.cfg index 5397ade6..79c78f71 100644 --- a/pjmedia/docs/doxygen.cfg +++ b/pjmedia/docs/doxygen.cfg @@ -17,7 +17,7 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "PJMEDIA and PJMEDIA-CODEC"
+PROJECT_NAME = "PJMEDIA Reference"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
diff --git a/pjmedia/docs/footer.html b/pjmedia/docs/footer.html index 86510676..c95d6f6f 100644 --- a/pjmedia/docs/footer.html +++ b/pjmedia/docs/footer.html @@ -1,3 +1,8 @@ - <!--#include virtual="/footer.html" --> +<p> </p> +<hr><center> +PJMEDIA small footprint Open Source media stack<br> +(C)2003-2006 Benny Prijono +</center> +<!--#include virtual="/footer.html" --> </BODY> </HTML> diff --git a/pjmedia/docs/header.html b/pjmedia/docs/header.html index fdafc676..61d5c99d 100644 --- a/pjmedia/docs/header.html +++ b/pjmedia/docs/header.html @@ -1,7 +1,8 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>PJMEDIA - Open Source media stack with RTP, RTCP, SDP, conference bridge, PLC, VAD, etc.</title> +<title>$title</title> <link href="/style/style.css" rel="stylesheet" type="text/css"> </head><body> <!--#include virtual="/header.html" --> + <p><A HREF="/">Home</A> --> <A HREF="/docs.htm">Documentations</A> --> PJMEDIA Reference</p> diff --git a/pjmedia/include/pjmedia/echo.h b/pjmedia/include/pjmedia/echo.h index 205ef4ff..c872bce9 100644 --- a/pjmedia/include/pjmedia/echo.h +++ b/pjmedia/include/pjmedia/echo.h @@ -29,7 +29,7 @@ /** - * @defgroup PJMEDIA_Echo_Cancel Canceller Echo Cancellation + * @defgroup PJMEDIA_Echo_Cancel Accoustic Echo Cancellation API * @ingroup PJMEDIA_PORT * @brief Echo Cancellation API. * @{ diff --git a/pjmedia/include/pjmedia/echo_port.h b/pjmedia/include/pjmedia/echo_port.h index 97abdc1f..d05c1a43 100644 --- a/pjmedia/include/pjmedia/echo_port.h +++ b/pjmedia/include/pjmedia/echo_port.h @@ -20,7 +20,7 @@ #define __PJMEDIA_AEC_PORT_H__ /** - * @file aec_port.h + * @file echo_port.h * @brief AEC (Accoustic Echo Cancellation) media port. */ #include <pjmedia/port.h> diff --git a/pjmedia/include/pjmedia/master_port.h b/pjmedia/include/pjmedia/master_port.h index ccc1bedd..79942ca8 100644 --- a/pjmedia/include/pjmedia/master_port.h +++ b/pjmedia/include/pjmedia/master_port.h @@ -70,7 +70,7 @@ typedef struct pjmedia_master_port pjmedia_master_port; * @param pool Pool to allocate master port from. * @param u_port Upstream port. * @param d_port Downstream port. - * @param options Options flags, bitmask from #pjmedia_master_port_flag. + * @param options Options flags, must be zero for now. * @param p_m Pointer to receive the master port instance. * * @return PJ_SUCCESS on success. diff --git a/pjmedia/include/pjmedia/port.h b/pjmedia/include/pjmedia/port.h index a7943667..7c108ed9 100644 --- a/pjmedia/include/pjmedia/port.h +++ b/pjmedia/include/pjmedia/port.h @@ -28,11 +28,11 @@ /** - @defgroup PJMEDIA_PORT_CONCEPT Media Ports + @defgroup PJMEDIA_PORT_CONCEPT Media Ports Framework @ingroup PJMEDIA @brief Extensible framework for media terminations - @section media_port_intro Concepts + @section media_port_intro Media Port Concepts @subsection The Media Port A media port (represented with pjmedia_port "class") provides a generic @@ -55,9 +55,6 @@ Some media ports (such as @ref PJMEDIA_CONF and @ref PJMEDIA_RESAMPLE_PORT) may be interconnected with each other, while some others represent the ultimate source/sink termination for the media. - The #pjmedia_port_connect() and #pjmedia_port_disconnect() are used to - connect and disconnect media ports respectively. But even when ports - are connected with each other ports, they still remain passive. @subsection port_clock_ex1 Example: Manual Resampling @@ -368,6 +365,7 @@ struct pjmedia_port * @param info The port info to be initialized. * @param name Port name. * @param signature Port signature. + * @param clock_rate Port's clock rate. * @param channel_count Number of channels. * @param bits_per_sample Bits per sample. * @param samples_per_frame Number of samples per frame. diff --git a/pjmedia/include/pjmedia/rtcp.h b/pjmedia/include/pjmedia/rtcp.h index 149678d5..357fda62 100644 --- a/pjmedia/include/pjmedia/rtcp.h +++ b/pjmedia/include/pjmedia/rtcp.h @@ -32,9 +32,23 @@ PJ_BEGIN_DECL /** - * @defgroup PJMED_RTCP RTCP Session + * @defgroup PJMED_RTCP RTCP Session and Encapsulation (RFC 3550) * @ingroup PJMEDIA_TRANSPORT * @{ + * PJMEDIA implements subsets of RTCP specification (RFC 3550) to monitor + * the quality of the real-time media (audio/video) transmission. In + * addition to the standard quality monitoring and reporting with RTCP + * SR and RR types, PJMEDIA's RTCP implementation is able to report + * extended statistics for incoming streams, such as packet duplications, + * reorder, discarded, and loss period (to distinguish between random + * and burst loss). + * + * The bidirectional media quality statistic is represented with + * #pjmedia_rtcp_stat structure. + * + * When application uses the stream interface (see @ref PJMED_STRM), + * application may retrieve the RTCP statistic by calling + * #pjmedia_stream_get_stat() function. */ #pragma pack(1) diff --git a/pjmedia/include/pjmedia/rtp.h b/pjmedia/include/pjmedia/rtp.h index 220a8634..b3e347cb 100644 --- a/pjmedia/include/pjmedia/rtp.h +++ b/pjmedia/include/pjmedia/rtp.h @@ -31,7 +31,7 @@ PJ_BEGIN_DECL /** - * @defgroup PJMED_RTP RTP Session + * @defgroup PJMED_RTP RTP Session and Encapsulation (RFC 3550) * @ingroup PJMEDIA_TRANSPORT * @{ * |