PJLIB Documentation

From 9cc109b6949507108721d624724ec22fc7da38de Mon Sep 17 00:00:00 2001 From: Benny Prijono Date: Thu, 24 Aug 2006 14:25:14 +0000 Subject: Just updated doxygen documentation git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@690 74dad513-b988-da41-8d7b-12977e46ad98 --- pjlib/docs/doxygen.cfg | 2 +- pjlib/docs/footer.html | 9 ++++++++- pjlib/docs/header.html | 4 +++- pjlib/include/pj/doxygen.h | 4 ++-- pjmedia/docs/doxygen.cfg | 2 +- pjmedia/docs/footer.html | 7 ++++++- pjmedia/docs/header.html | 3 ++- pjmedia/include/pjmedia/echo.h | 2 +- pjmedia/include/pjmedia/echo_port.h | 2 +- pjmedia/include/pjmedia/master_port.h | 2 +- pjmedia/include/pjmedia/port.h | 8 +++----- pjmedia/include/pjmedia/rtcp.h | 16 +++++++++++++++- pjmedia/include/pjmedia/rtp.h | 2 +- pjsip/docs/doxygen.cfg | 2 +- pjsip/docs/footer.html | 7 ++++++- pjsip/docs/header.html | 3 ++- pjsip/include/pjsua-lib/pjsua.h | 9 +++++++++ pjsip/src/pjsua-lib/pjsua_core.c | 7 +++++++ 18 files changed, 70 insertions(+), 21 deletions(-) diff --git a/pjlib/docs/doxygen.cfg b/pjlib/docs/doxygen.cfg index 28c02a0f..d167fdb4 100644 --- a/pjlib/docs/doxygen.cfg +++ b/pjlib/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 = PJLIB +PROJECT_NAME = "PJLIB Open Source" # 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/pjlib/docs/footer.html b/pjlib/docs/footer.html index 7e7b5529..2c7f93aa 100644 --- a/pjlib/docs/footer.html +++ b/pjlib/docs/footer.html @@ -1,4 +1,11 @@ - +

+PJLIB Open Source, high performance, small footprint, and very very portable framework
+(C)2003-2006 Benny Prijono + + + + diff --git a/pjlib/docs/header.html b/pjlib/docs/header.html index a32695a7..5517dc34 100644 --- a/pjlib/docs/header.html +++ b/pjlib/docs/header.html @@ -1,7 +1,9 @@ -PJLIB Documentation +$title +

Home --> Documentations --> PJLIB Reference

+ diff --git a/pjlib/include/pj/doxygen.h b/pjlib/include/pj/doxygen.h index 2d022bb2..95ba72e5 100644 --- a/pjlib/include/pj/doxygen.h +++ b/pjlib/include/pj/doxygen.h @@ -44,7 +44,7 @@ * @section download_sec Download * * PJLIB and all documentation can be downloaded from - * http://www.pjproject.net. + * http://www.pjsip.org. * * * @section how_to_use_sec About This Documentation @@ -55,7 +55,7 @@ * * @subsection doc_ver_subsec Version * - * This document corresponds to PJLIB version 0.5.6. + * This document corresponds to PJLIB version 0.5.7.6. * * * @subsection find_samples_subsec How to Read This Document 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 @@ - +

+PJMEDIA small footprint Open Source media stack
+(C)2003-2006 Benny Prijono + + 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 @@ -PJMEDIA - Open Source media stack with RTP, RTCP, SDP, conference bridge, PLC, VAD, etc. +$title +

Home --> Documentations --> PJMEDIA Reference

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 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 * @{ * diff --git a/pjsip/docs/doxygen.cfg b/pjsip/docs/doxygen.cfg index 59d6e659..9de6aa81 100644 --- a/pjsip/docs/doxygen.cfg +++ b/pjsip/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 = PJSIP +PROJECT_NAME = "PJSIP 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/pjsip/docs/footer.html b/pjsip/docs/footer.html index 7e7b5529..cafc0b6b 100644 --- a/pjsip/docs/footer.html +++ b/pjsip/docs/footer.html @@ -1,4 +1,9 @@ - +

+PJSIP Open Source, high performance, small footprint, and very very portable SIP stack
+(C)2003-2006 Benny Prijono + + diff --git a/pjsip/docs/header.html b/pjsip/docs/header.html index 9faaf8d8..767dbaa4 100644 --- a/pjsip/docs/header.html +++ b/pjsip/docs/header.html @@ -1,7 +1,8 @@ -PJSIP - Open Source SIP, SIMPLE, Presence, IM Protocol Stack Documentation +$title +

Home --> Documentations --> PJSIP Reference

diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index 2ffea4cc..d2ca7a34 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -617,6 +617,15 @@ PJ_DECL(pjsip_endpoint*) pjsua_get_pjsip_endpt(void); */ PJ_DECL(pjmedia_endpt*) pjsua_get_pjmedia_endpt(void); +/** + * Internal function to get PJSUA pool factory. + * Only valid after #pjsua_init() is called. + * + * @return Pool factory currently used by PJSUA. + */ +PJ_DECL(pj_pool_factory*) pjsua_get_pool_factory(void); + + /***************************************************************************** * Utilities. diff --git a/pjsip/src/pjsua-lib/pjsua_core.c b/pjsip/src/pjsua-lib/pjsua_core.c index a0a87fbe..ea4b0635 100644 --- a/pjsip/src/pjsua-lib/pjsua_core.c +++ b/pjsip/src/pjsua-lib/pjsua_core.c @@ -746,6 +746,13 @@ PJ_DEF(pjmedia_endpt*) pjsua_get_pjmedia_endpt(void) return pjsua_var.med_endpt; } +/* + * Internal function to get PJSUA pool factory. + */ +PJ_DEF(pj_pool_factory*) pjsua_get_pool_factory(void) +{ + return &pjsua_var.cp.factory; +} /***************************************************************************** * PJSUA SIP Transport API. -- cgit v1.2.3