Changeset 736


Ignore:
Timestamp:
Sep 22, 2006 8:43:00 PM (15 years ago)
Author:
bennylp
Message:

Updated doxygen documentation for the website

Location:
pjproject/trunk
Files:
2 added
9 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjlib/include/pj/doxygen.h

    r691 r736  
    5656 * @subsection doc_ver_subsec Version 
    5757 * 
    58  * This document corresponds to PJLIB version 0.5.7.6. 
     58 * This document corresponds to PJLIB version 0.5.8. 
    5959 * 
    6060 * 
     
    457457 * 
    458458 * @section build_sys_install_sec Build and Installation 
     459 * 
     460 * \note 
     461 * <b>The most up-to-date information on building and installing PJLIB 
     462 *  should be found in the website, under "Getting Started" document. 
     463 *  More over, the new PJLIB build system is now based on autoconf, 
     464 *  so some of the information here might not be relevant anymore  
     465 *  (although most still are, since the autoconf script still use 
     466 *  the old Makefile system as the backend).</b> 
    459467 * 
    460468 * @subsection build_sys_install_win32_sec Visual Studio 
     
    794802 * @page porting_pjlib_pg Porting PJLIB 
    795803 * 
     804 * \note 
     805 * <b>Since version 0.5.8, PJLIB build system is now based on autoconf, so 
     806 * most of the time we shouldn't need to apply the tweakings below to get 
     807 * PJLIB working on a new platform. However, since the autoconf build system 
     808 * still uses the old Makefile build system, the information below may still 
     809 * be useful for reference. 
     810 * </b> 
    796811 * 
    797812 * @section new_arch_sec Porting to New CPU Architecture 
  • pjproject/trunk/pjlib/include/pj/pool.h

    r691 r736  
    102102 * memory allocation strategy that can speed-up the memory allocations 
    103103 * and deallocations by up to <b>30 times</b> compared to standard 
    104  * malloc()/free()! 
     104 * malloc()/free() (more than 150 million allocations per second on a 
     105 * P4/3.0GHz Linux machine). 
    105106 * 
    106107 * (Note: your mileage may vary, of course. You can see how much PJLIB's 
  • pjproject/trunk/pjmedia/include/pjmedia/doxygen.h

    r531 r736  
    493493    Screenshots on WinXP: \image html siprtp.jpg "siprtp screenshot on WinXP" 
    494494 
     495  - @ref page_pjmedia_samples_tonegen_c\n 
     496    This is a simple program to generate a tone and write the samples to 
     497    a raw PCM file. The main purpose of this file is to analyze the 
     498    quality of the tones/sine wave generated by PJMEDIA tone/sine wave 
     499    generator. 
     500 
     501  - @ref page_pjmedia_samples_aectest_c\n 
     502    Play a file to speaker, run AEC, and record the microphone input 
     503    to see if echo is coming. 
    495504 */ 
    496505 
  • pjproject/trunk/pjsip-apps/src/samples/tonegen.c

    r693 r736  
    1717 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA  
    1818 */ 
     19 
     20/** 
     21 * \page page_pjmedia_samples_tonegen_c Samples: Sine Wave/Dual-Tone Generation 
     22 * 
     23 * This is a simple program to generate a tone and write the samples to 
     24 * a raw PCM file. The main purpose of this file is to analyze the 
     25 * quality of the tones/sine wave generated by PJMEDIA tone/sine wave 
     26 * generator. 
     27 * 
     28 * This file is pjsip-apps/src/samples/tonegen.c 
     29 * 
     30 * \includelineno tonegen.c 
     31 */ 
     32 
     33 
    1934#include <pjmedia.h> 
    2035#include <pjlib.h> 
  • pjproject/trunk/pjsip/docs/doxygen.h

    r531 r736  
    2929 
    3030/** 
    31  
    32   @mainpage PJSIP 
     31  \n 
     32 
     33  @mainpage PJSIP - Open Source SIP Stack 
    3334 
    3435  \n 
     
    119120  @subsection doc_ver Version 
    120121 
    121   This document corresponds to PJSIP version 0.5.6. 
     122  This document corresponds to PJSIP version 0.5.8. 
    122123 
    123124  \n 
     
    217218    Screenshots on WinXP: \image html siprtp.jpg "siprtp screenshot on WinXP" 
    218219 
     220  - @ref page_pjsip_perf_c\n 
     221    This sample contains a complete implementation of a SIP performance 
     222    measurement tool. Unlike other tool such SIPp, pjsip-perf is geared 
     223    more towards finding the performance of an endpoint by flooding the 
     224    endpoint with some requests and time the completion of the requests.\n 
     225    Screenshots on Linux console: \image html pjsip-perf.jpg "pjsip-perf screenshot on Linux" 
    219226 */ 
    220227 
     
    255262 
    256263/** 
    257  * \page page_pjmedia_samples_siprtp_c Samples: Using SIP and Custom RTP/RTCP to Monitor Quality 
     264 * \page page_pjmedia_samples_siprtp_c Samples: siprtp - SIP with RTCP Quality Monitoring 
    258265 * 
    259266 * This source is an example to demonstrate using SIP and RTP/RTCP framework 
     
    275282 */ 
    276283 
     284/** 
     285 * \page page_pjsip_perf_c Samples: pjsip-perf - SIP Performance Benchmarking Tool 
     286 * 
     287 * This sample contains a complete implementation of a SIP performance 
     288 * measurement tool. Unlike other tool such SIPp, pjsip-perf is geared 
     289 * more towards finding the performance of an endpoint by flooding the 
     290 * endpoint with some requests and time the completion of the requests. 
     291 * 
     292 * The source code of the file is pjsip-apps/src/samples/pjsip-perf.c 
     293 * 
     294 * Screenshots on Linux console: \image html pjsip-perf.jpg 
     295 * 
     296 * \includelineno pjsip-perf.c 
     297 */ 
     298 
  • pjproject/trunk/pjsip/include/pjsip/sip_endpoint.h

    r515 r736  
    245245/** 
    246246 * Register the transaction to the endpoint's transaction table. 
    247  * Before the transaction is registered, it must have been initialized as 
    248  * either UAS or UAC by calling #pjsip_tsx_init_uac or #pjsip_tsx_init_uas. 
    249  * This function, like all other endpoint functions, is thread safe. 
     247 * This function should only be used internally by the stack. 
    250248 * 
    251249 * @param endpt     The SIP endpoint. 
     
    256254 
    257255/** 
    258  * Forcefull destroy the transaction. 
    259  * The only time where application needs to call this function is when the 
    260  * transaction fails to initialize in #pjsip_tsx_init_uac or 
    261  * #pjsip_tsx_init_uas. For other cases. the transaction will be destroyed 
    262  * automaticly by endpoint. 
     256 * Forcefull destroy the transaction. This function should only be used 
     257 * internally by the stack. 
    263258 * 
    264259 * @param endpt     The endpoint. 
  • pjproject/trunk/pjsip/include/pjsip/sip_msg.h

    r715 r736  
    911911 * as argument to a function which will copy the header). 
    912912 * 
    913  * @param pool      The pool. 
     913 * @param h         The header to be initialized. 
    914914 * @param hname     The header name to be assigned to the header, or NULL to 
    915915 *                  assign the header name with some string. 
  • pjproject/trunk/pjsip/include/pjsip/sip_transport.h

    r720 r736  
    361361 * 
    362362 * A transaction object normally will add reference counter to this buffer 
    363  * when application calls #pjsip_tsx_on_tx_msg, because it needs to keep the 
     363 * when application calls #pjsip_tsx_send_msg, because it needs to keep the 
    364364 * message for retransmission. The transaction will release the reference 
    365365 * counter once its state has reached final state. 
  • pjproject/trunk/pjsip/include/pjsip/sip_util.h

    r515 r736  
    396396 * This is an auxiliary function to be used by application to send arbitrary 
    397397 * requests outside a dialog. To send a request within a dialog, application 
    398  * should use #pjsip_dlg_send_msg instead. 
     398 * should use #pjsip_dlg_send_request instead. 
    399399 * 
    400400 * @param endpt     The endpoint instance. 
Note: See TracChangeset for help on using the changeset viewer.