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/account.hpp

    r4659 r4672  
    2929#include <pjsua2/siptypes.hpp> 
    3030 
     31/** PJSUA2 API is inside pj namespace */ 
     32namespace pj 
     33{ 
     34 
    3135/** 
    3236 * @defgroup PJSUA2_ACC Account 
    3337 * @ingroup PJSUA2_Ref 
    34  */ 
    35  
    36 /** 
    37  * @defgroup PJSUA2_Acc_Data_Structure Data Structure 
    38  * @ingroup PJSUA2_Ref 
    3938 * @{ 
    4039 */ 
    4140 
    42 /** PJSUA2 API is inside pj namespace */ 
    43 namespace pj 
    44 { 
    4541using std::string; 
    4642 
    … …  
    9187     * See also \a firstRetryIntervalSec setting. 
    9288     * 
    93      * Default: #PJSUA_REG_RETRY_INTERVAL 
     89     * Default: PJSUA_REG_RETRY_INTERVAL 
    9490     */ 
    9591    unsigned            retryIntervalSec; 
    … …  
    263259    /** 
    264260     * Specify how to offer call hold to remote peer. Please see the 
    265      * documentation on #pjsua_call_hold_type for more info. 
     261     * documentation on pjsua_call_hold_type for more info. 
    266262     * 
    267263     * Default: PJSUA_CALL_HOLD_TYPE_DEFAULT 
    … …  
    280276    /** 
    281277     * Specify the usage of Session Timers for all sessions. See the 
    282      * #pjsua_sip_timer_use for possible values. 
     278     * pjsua_sip_timer_use for possible values. 
    283279     * 
    284280     * Default: PJSUA_SIP_TIMER_OPTIONAL 
    … …  
    677673    /** 
    678674     * Specify whether stream keep-alive and NAT hole punching with 
    679      * non-codec-VAD mechanism (see @ref PJMEDIA_STREAM_ENABLE_KA) is enabled 
     675     * non-codec-VAD mechanism (see PJMEDIA_STREAM_ENABLE_KA) is enabled 
    680676     * for this account. 
    681677     * 
    … …  
    689685     * PJMEDIA_SRTP_MANDATORY. 
    690686     * 
    691      * Default: #PJSUA_DEFAULT_USE_SRTP 
     687     * Default: PJSUA_DEFAULT_USE_SRTP 
    692688     */ 
    693689    pjmedia_srtp_use    srtpUse; 
    … …  
    702698     *  2: SRTP requires secure end-to-end transport (SIPS) 
    703699     * 
    704      * Default: #PJSUA_DEFAULT_SRTP_SECURE_SIGNALING 
     700     * Default: PJSUA_DEFAULT_SRTP_SECURE_SIGNALING 
    705701     */ 
    706702    int                 srtpSecureSignaling; 
    … …  
    739735     * Regardless of this setting, application can detect incoming video 
    740736     * by implementing \a on_call_media_state() callback and enumerating 
    741      * the media stream(s) with #pjsua_call_get_info(). Once incoming 
     737     * the media stream(s) with pjsua_call_get_info(). Once incoming 
    742738     * video is recognised, application may retrieve the window associated 
    743739     * with the incoming video and show or hide it with 
    744      * #pjsua_vid_win_set_show(). 
     740     * pjsua_vid_win_set_show(). 
    745741     * 
    746742     * Default: False 
    … …  
    757753     * 
    758754     * Regardless of the value of this setting, application can start and 
    759      * stop outgoing video transmission with #pjsua_call_set_vid_strm(). 
     755     * stop outgoing video transmission with pjsua_call_set_vid_strm(). 
    760756     * 
    761757     * Default: False 
    … …  
    765761    /** 
    766762     * Specify video window's flags. The value is a bitmask combination of 
    767      * #pjmedia_vid_dev_wnd_flag. 
     763     * pjmedia_vid_dev_wnd_flag. 
    768764     * 
    769765     * Default: 0 
    … …  
    984980 
    985981public: 
     982    /** Import from pjsip data */ 
    986983    void fromPj(const pjsua_acc_info &pai); 
    987984}; 
    … …  
    12741271}; 
    12751272 
    1276 /** 
    1277  * @}  // PJSUA2_Acc_Data_Structure 
    1278  */ 
    1279  
    1280 /** 
    1281  * @addtogroup PJSUA2_ACC 
    1282  * @{ 
    1283  */ 
    1284  
    12851273 
    12861274/** 
    … …  
    13151303     * reregistration on the account. 
    13161304     * 
    1317      * @param cfg               New account config to be applied to the account. 
    1318      */ 
    1319     void modify(const AccountConfig &acc) throw(Error); 
     1305     * @param cfg               New account config to be applied to the 
     1306     *                          account. 
     1307     */ 
     1308    void modify(const AccountConfig &cfg) throw(Error); 
    13201309 
    13211310    /** 
    … …  
    14951484     *    parameter. In this case, the library will automatically send NOTIFY 
    14961485     *    request upon returning from this callback. 
    1497      *  - it may delay the processing of the request, for example to request 
     1486     *  - it may delay the processing of the request, for example to request 
    14981487     *    user permission whether to accept or reject the request. In this 
    14991488     *    case, the application MUST set the IncomingSubscribeParam.code 
    … …  
    15591548}; 
    15601549 
     1550/** 
     1551 * @}  // PJSUA2_ACC 
     1552 */ 
     1553 
    15611554} // namespace pj 
    15621555 
    1563 /** 
    1564  * @}  // PJSUA2_ACC 
    1565  */ 
    1566  
    15671556#endif  /* __PJSUA2_ACCOUNT_HPP__ */ 
    15681557 
Note: See TracChangeset for help on using the changeset viewer.