Changeset 690


Ignore:
Timestamp:
Aug 24, 2006 2:25:14 PM (16 years ago)
Author:
bennylp
Message:

Just updated doxygen documentation

Location:
pjproject/trunk
Files:
18 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjlib/docs/doxygen.cfg

    r48 r690  
    1818# by quotes) that should identify the project. 
    1919 
    20 PROJECT_NAME           =  PJLIB 
     20PROJECT_NAME           =  "PJLIB Open Source" 
    2121 
    2222# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
  • pjproject/trunk/pjlib/docs/footer.html

    r514 r690  
    1         <!--#include virtual="/footer.html" --> 
     1<p>&nbsp;</p> 
     2<hr><center> 
     3PJLIB Open Source, high performance, small footprint, and very very portable framework<br> 
     4(C)2003-2006 Benny Prijono 
     5</center> 
     6 
     7 
     8<!--#include virtual="/footer.html" --> 
    29 
    310</BODY> 
  • pjproject/trunk/pjlib/docs/header.html

    r514 r690  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 
    3 <title>PJLIB Documentation</title> 
     3<title>$title</title> 
    44<link href="/style/style.css" rel="stylesheet" type="text/css"> 
    55</head><body> 
    66        <!--#include virtual="/header.html" --> 
     7        <p><A HREF="/">Home</A> --&gt; <A HREF="/docs.htm">Documentations</A> --&gt; PJLIB Reference</p> 
    78 
     9 
  • pjproject/trunk/pjlib/include/pj/doxygen.h

    r514 r690  
    4545 * 
    4646 * PJLIB and all documentation can be downloaded from  
    47  * http://www.pjproject.net. 
     47 * http://www.pjsip.org. 
    4848 * 
    4949 * 
     
    5656 * @subsection doc_ver_subsec Version 
    5757 * 
    58  * This document corresponds to PJLIB version 0.5.6. 
     58 * This document corresponds to PJLIB version 0.5.7.6. 
    5959 * 
    6060 * 
  • pjproject/trunk/pjmedia/docs/doxygen.cfg

    r531 r690  
    1818# by quotes) that should identify the project. 
    1919 
    20 PROJECT_NAME           =  "PJMEDIA and PJMEDIA-CODEC" 
     20PROJECT_NAME           =  "PJMEDIA Reference" 
    2121 
    2222# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
  • pjproject/trunk/pjmedia/docs/footer.html

    r518 r690  
    1         <!--#include virtual="/footer.html" --> 
     1<p>&nbsp;</p> 
     2<hr><center> 
     3PJMEDIA small footprint Open Source media stack<br> 
     4(C)2003-2006 Benny Prijono 
     5</center> 
     6<!--#include virtual="/footer.html" --> 
    27</BODY> 
    38</HTML> 
  • pjproject/trunk/pjmedia/docs/header.html

    r518 r690  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 
    3 <title>PJMEDIA - Open Source media stack with RTP, RTCP, SDP, conference bridge, PLC, VAD, etc.</title> 
     3<title>$title</title> 
    44<link href="/style/style.css" rel="stylesheet" type="text/css"> 
    55</head><body> 
    66        <!--#include virtual="/header.html" --> 
    77 
     8        <p><A HREF="/">Home</A> --&gt; <A HREF="/docs.htm">Documentations</A> --&gt; PJMEDIA Reference</p> 
  • pjproject/trunk/pjmedia/include/pjmedia/echo.h

    r653 r690  
    3030 
    3131/** 
    32  * @defgroup PJMEDIA_Echo_Cancel Canceller Echo Cancellation 
     32 * @defgroup PJMEDIA_Echo_Cancel Accoustic Echo Cancellation API 
    3333 * @ingroup PJMEDIA_PORT 
    3434 * @brief Echo Cancellation API. 
  • pjproject/trunk/pjmedia/include/pjmedia/echo_port.h

    r653 r690  
    2121 
    2222/** 
    23  * @file aec_port.h 
     23 * @file echo_port.h 
    2424 * @brief AEC (Accoustic Echo Cancellation) media port. 
    2525 */ 
  • pjproject/trunk/pjmedia/include/pjmedia/master_port.h

    r518 r690  
    7171 * @param u_port        Upstream port. 
    7272 * @param d_port        Downstream port. 
    73  * @param options       Options flags, bitmask from #pjmedia_master_port_flag. 
     73 * @param options       Options flags, must be zero for now. 
    7474 * @param p_m           Pointer to receive the master port instance. 
    7575 * 
  • pjproject/trunk/pjmedia/include/pjmedia/port.h

    r633 r690  
    2929 
    3030/** 
    31   @defgroup PJMEDIA_PORT_CONCEPT Media Ports 
     31  @defgroup PJMEDIA_PORT_CONCEPT Media Ports Framework 
    3232  @ingroup PJMEDIA 
    3333  @brief Extensible framework for media terminations 
    3434   
    35   @section media_port_intro Concepts 
     35  @section media_port_intro Media Port Concepts 
    3636   
    3737  @subsection The Media Port 
     
    5656  may be interconnected with each other, while some 
    5757  others represent the ultimate source/sink termination for the media.  
    58   The  #pjmedia_port_connect() and #pjmedia_port_disconnect() are used to 
    59   connect and disconnect media ports respectively. But even when ports 
    60   are connected with each other ports, they still remain passive. 
    6158 
    6259 
     
    369366 * @param name              Port name. 
    370367 * @param signature         Port signature. 
     368 * @param clock_rate        Port's clock rate. 
    371369 * @param channel_count     Number of channels. 
    372370 * @param bits_per_sample   Bits per sample. 
  • pjproject/trunk/pjmedia/include/pjmedia/rtcp.h

    r567 r690  
    3333 
    3434/** 
    35  * @defgroup PJMED_RTCP RTCP Session 
     35 * @defgroup PJMED_RTCP RTCP Session and Encapsulation (RFC 3550) 
    3636 * @ingroup PJMEDIA_TRANSPORT 
    3737 * @{ 
     38 * PJMEDIA implements subsets of RTCP specification (RFC 3550) to monitor 
     39 * the quality of the real-time media (audio/video) transmission. In 
     40 * addition to the standard quality monitoring and reporting with RTCP 
     41 * SR and RR types, PJMEDIA's RTCP implementation is able to report 
     42 * extended statistics for incoming streams, such as packet duplications, 
     43 * reorder, discarded, and loss period (to distinguish between random 
     44 * and burst loss). 
     45 * 
     46 * The bidirectional media quality statistic is represented with 
     47 * #pjmedia_rtcp_stat structure. 
     48 * 
     49 * When application uses the stream interface (see @ref PJMED_STRM), 
     50 * application may retrieve the RTCP statistic by calling  
     51 * #pjmedia_stream_get_stat() function. 
    3852 */ 
    3953 
  • pjproject/trunk/pjmedia/include/pjmedia/rtp.h

    r531 r690  
    3232 
    3333/** 
    34  * @defgroup PJMED_RTP RTP Session 
     34 * @defgroup PJMED_RTP RTP Session and Encapsulation (RFC 3550) 
    3535 * @ingroup PJMEDIA_TRANSPORT 
    3636 * @{ 
  • pjproject/trunk/pjsip/docs/doxygen.cfg

    r531 r690  
    1818# by quotes) that should identify the project. 
    1919 
    20 PROJECT_NAME           =  PJSIP 
     20PROJECT_NAME           =  "PJSIP Reference" 
    2121 
    2222# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
  • pjproject/trunk/pjsip/docs/footer.html

    r515 r690  
    1         <!--#include virtual="/footer.html" --> 
     1<p>&nbsp;</p> 
     2<hr><center> 
     3PJSIP Open Source, high performance, small footprint, and very very portable SIP stack<br> 
     4(C)2003-2006 Benny Prijono 
     5</center> 
     6<!--#include virtual="/footer.html" --> 
    27 
    38</BODY> 
  • pjproject/trunk/pjsip/docs/header.html

    r515 r690  
    11<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    22<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 
    3 <title>PJSIP - Open Source SIP, SIMPLE, Presence, IM Protocol Stack Documentation</title> 
     3<title>$title</title> 
    44<link href="/style/style.css" rel="stylesheet" type="text/css"> 
    55</head><body> 
    66        <!--#include virtual="/header.html" --> 
     7        <p><A HREF="/">Home</A> --&gt; <A HREF="/docs.htm">Documentations</A> --&gt; PJSIP Reference</p> 
    78 
  • pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

    r685 r690  
    617617 */ 
    618618PJ_DECL(pjmedia_endpt*) pjsua_get_pjmedia_endpt(void); 
     619 
     620/** 
     621 * Internal function to get PJSUA pool factory. 
     622 * Only valid after #pjsua_init() is called. 
     623 * 
     624 * @return              Pool factory currently used by PJSUA. 
     625 */ 
     626PJ_DECL(pj_pool_factory*) pjsua_get_pool_factory(void); 
     627 
    619628 
    620629 
  • pjproject/trunk/pjsip/src/pjsua-lib/pjsua_core.c

    r688 r690  
    747747} 
    748748 
     749/* 
     750 * Internal function to get PJSUA pool factory. 
     751 */ 
     752PJ_DEF(pj_pool_factory*) pjsua_get_pool_factory(void) 
     753{ 
     754    return &pjsua_var.cp.factory; 
     755} 
    749756 
    750757/***************************************************************************** 
Note: See TracChangeset for help on using the changeset viewer.