Ignore:
Timestamp:
Dec 4, 2013 3:01:20 AM (10 years ago)
Author:
bennylp
Message:

Re #1519: doxygen fixes and other minor fixes

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/endpoint.hpp

    r4670 r4672  
    2121 
    2222/** 
    23  * @file pjsua2/ua.hpp 
     23 * @file pjsua2/endpoint.hpp 
    2424 * @brief PJSUA2 Base Agent Operation 
    2525 */ 
    … …  
    3333 
    3434/** 
    35  * @defgroup PJSUA2_UA Base Endpoint Operations 
     35 * @defgroup PJSUA2_UA Endpoint 
    3636 * @ingroup PJSUA2_Ref 
    3737 * @{ 
    … …  
    163163 
    164164////////////////////////////////////////////////////////////////////////////// 
    165  
     165/** 
     166 * SIP User Agent related settings. 
     167 */ 
    166168struct UaConfig : public PersistentObject 
    167169{ 
    … …  
    213215     * 
    214216     * When nameserver is not configured, entries will be resolved with 
    215      * #pj_gethostbyname() if it's not an IP address. Port number may be 
     217     * pj_gethostbyname() if it's not an IP address. Port number may be 
    216218     * specified if the server is not listening in standard STUN port. 
    217219     */ 
    … …  
    343345 
    344346    /** 
    345      * Additional flags to be given to #pj_file_open() when opening 
     347     * Additional flags to be given to pj_file_open() when opening 
    346348     * the log file. By default, the flag is PJ_O_WRONLY. Application 
    347349     * may set PJ_O_APPEND here so that logs are appended to existing 
    … …  
    499501 
    500502    /** 
    501      * Echo canceller options (see #pjmedia_echo_create()) 
     503     * Echo canceller options (see pjmedia_echo_create()) 
    502504     * 
    503505     * Default: 0. 
    … …  
    791793    /** 
    792794     * Schedule a timer with the specified interval and user data. When the 
    793      * interval elapsed, Endpoint::onTimer() callback will be 
     795     * interval elapsed, onTimer() callback will be 
    794796     * called. Note that the callback may be executed by different thread, 
    795797     * depending on whether worker thread is enabled or not. 
    … …  
    811813     *                          previous utilTimerSchedule() call. 
    812814     */ 
    813     void utilTimerCancel(Token prmTimerToken); 
     815    void utilTimerCancel(Token prmToken); 
    814816 
    815817    /** 
    … …  
    824826     * This is a utility function to detect NAT type in front of this endpoint. 
    825827     * Once invoked successfully, this function will complete asynchronously 
    826      * and report the result in Endpoint::onNatDetectionComplete(). 
     828     * and report the result in onNatDetectionComplete(). 
    827829     * 
    828830     * After NAT has been detected and the callback is called, application can 
    829      * get the detected NAT type by calling #natGetType(). Application 
    830      * can also perform NAT detection by calling #natDetectType() 
     831     * get the detected NAT type by calling natGetType(). Application 
     832     * can also perform NAT detection by calling natDetectType() 
    831833     * again at later time. 
    832834     * 
    … …  
    836838 
    837839    /** 
    838      * Get the NAT type as detected by #natDetectType() function. This 
    839      * function will only return useful NAT type after #natDetectType() 
    840      * has completed successfully and Endpoint::onNatDetectionComplete() 
     840     * Get the NAT type as detected by natDetectType() function. This 
     841     * function will only return useful NAT type after natDetectType() 
     842     * has completed successfully and onNatDetectionComplete() 
    841843     * callback has been called. 
    842844     * 
    … …  
    848850    /** 
    849851     * Auxiliary function to resolve and contact each of the STUN server 
    850      * entries (sequentially) to find which is usable. The #pjsua_init() must 
     852     * entries (sequentially) to find which is usable. The libInit() must 
    851853     * have been called before calling this function. 
    852854     * 
    … …  
    966968     * @param media     media to be added. 
    967969     */ 
    968     void addMedia(AudioMedia &media); 
     970    void mediaAdd(AudioMedia &media); 
    969971 
    970972    /** 
    … …  
    973975     * @param media     media to be removed. 
    974976     */ 
    975     void removeMedia(AudioMedia &media); 
     977    void mediaRemove(AudioMedia &media); 
    976978 
    977979    /** 
    … …  
    10051007    const AudioMediaVector &mediaEnumPorts() const throw(Error); 
    10061008 
     1009    /** 
     1010     * Get the instance of Audio Device Manager. 
     1011     * 
     1012     * @return          The Audio Device Manager. 
     1013     */ 
    10071014    AudDevManager &audDevManager(); 
    10081015 
    … …  
    10601067    /** 
    10611068     * Callback when the Endpoint has finished performing NAT type 
    1062      * detection that is initiated with Endpoint::natDetectType(). 
     1069     * detection that is initiated with natDetectType(). 
    10631070     * 
    10641071     * @param prm       Callback parameters containing the detection 
    … …  
    10711078    /** 
    10721079     * Callback when the Endpoint has finished performing STUN server 
    1073      * checking that is initiated with Endpoint::natCheckStunServers(). 
     1080     * checking that is initiated with natCheckStunServers(). 
    10741081     * 
    10751082     * @param prm       Callback parameters. 
    … …  
    10901097    /** 
    10911098     * Callback when a timer has fired. The timer was scheduled by 
    1092      * Endpoint::utilTimerSchedule(). 
     1099     * utilTimerSchedule(). 
    10931100     * 
    10941101     * @param prm       Callback parameters. 
Note: See TracChangeset for help on using the changeset viewer.