Changeset 4672


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

Re #1519: doxygen fixes and other minor fixes

Location:
pjproject/branches/projects/pjsua2/pjsip
Files:
14 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 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/call.hpp

    r4670 r4672  
    2727#include <pjsua2/media.hpp> 
    2828 
     29/** PJSUA2 API is inside pj namespace */ 
     30namespace pj 
     31{ 
     32 
    2933/** 
    3034 * @defgroup PJSUA2_CALL Call 
     
    3337 
    3438/** 
    35  * @defgroup PJSUA2_Call_Data_Structure Data Structure 
    36  * @ingroup PJSUA2_Ref 
     39 * @defgroup PJSUA2_Call_Data_Structure Call Related Types 
     40 * @ingroup PJSUA2_DS 
    3741 * @{ 
    3842 */ 
    3943 
    40 /** PJSUA2 API is inside pj namespace */ 
    41 namespace pj 
    42 { 
    4344using std::string; 
    4445using std::vector; 
     
    308309{ 
    309310    /** 
    310      * Bitmask of #pjsua_call_flag constants. 
     311     * Bitmask of pjsua_call_flag constants. 
    311312     * 
    312313     * Default: PJSUA_CALL_INCLUDE_DISABLED_MEDIA 
     
    316317    /** 
    317318     * This flag controls what methods to request keyframe are allowed on 
    318      * the call. Value is bitmask of #pjsua_vid_req_keyframe_method. 
     319     * the call. Value is bitmask of pjsua_vid_req_keyframe_method. 
    319320     * 
    320321     * Default: PJSUA_VID_REQ_KEYFRAME_SIP_INFO | 
     
    622623 
    623624/** 
    624  * This structure contains parameters for onCallState() callback. 
     625 * This structure contains parameters for Call::onCallState() callback. 
    625626 */ 
    626627struct OnCallStateParam 
     
    633634 
    634635/** 
    635  * This structure contains parameters for onCallTsxState() callback. 
     636 * This structure contains parameters for Call::onCallTsxState() callback. 
    636637 */ 
    637638struct OnCallTsxStateParam 
     
    644645 
    645646/** 
    646  * This structure contains parameters for onCallMediaState() callback. 
     647 * This structure contains parameters for Call::onCallMediaState() callback. 
    647648 */ 
    648649struct OnCallMediaStateParam 
     
    651652 
    652653/** 
    653  * This structure contains parameters for onCallSdpCreated() callback. 
     654 * This structure contains parameters for Call::onCallSdpCreated() callback. 
    654655 */ 
    655656struct OnCallSdpCreatedParam 
     
    667668 
    668669/** 
    669  * This structure contains parameters for onStreamCreated() callback. 
     670 * This structure contains parameters for Call::onStreamCreated() 
     671 * callback. 
    670672 */ 
    671673struct OnStreamCreatedParam 
     
    690692 
    691693/** 
    692  * This structure contains parameters for onStreamDestroyed() callback. 
     694 * This structure contains parameters for Call::onStreamDestroyed() 
     695 * callback. 
    693696 */ 
    694697struct OnStreamDestroyedParam 
     
    706709 
    707710/** 
    708  * This structure contains parameters for onDtmfDigit() callback. 
     711 * This structure contains parameters for Call::onDtmfDigit() 
     712 * callback. 
    709713 */ 
    710714struct OnDtmfDigitParam 
     
    717721 
    718722/** 
    719  * This structure contains parameters for onCallTransferRequest() callback. 
     723 * This structure contains parameters for Call::onCallTransferRequest() 
     724 * callback. 
    720725 */ 
    721726struct OnCallTransferRequestParam 
     
    740745 
    741746/** 
    742  * This structure contains parameters for onCallTransferStatus() callback. 
     747 * This structure contains parameters for Call::onCallTransferStatus() 
     748 * callback. 
    743749 */ 
    744750struct OnCallTransferStatusParam 
     
    769775 
    770776/** 
    771  * This structure contains parameters for onCallReplaceRequest() callback. 
     777 * This structure contains parameters for Call::onCallReplaceRequest() 
     778 * callback. 
    772779 */ 
    773780struct OnCallReplaceRequestParam 
     
    797804 
    798805/** 
    799  * This structure contains parameters for onCallReplaced() callback. 
     806 * This structure contains parameters for Call::onCallReplaced() callback. 
    800807 */ 
    801808struct OnCallReplacedParam 
     
    808815 
    809816/** 
    810  * This structure contains parameters for onCallRxOffer() callback. 
     817 * This structure contains parameters for Call::onCallRxOffer() callback. 
    811818 */ 
    812819struct OnCallRxOfferParam 
     
    831838}; 
    832839 
     840/** 
     841 * This structure contains parameters for Call::onCallRedirected() callback. 
     842 */ 
    833843struct OnCallRedirectedParam 
    834844{ 
     
    843853     * received for the INVITE sent to subsequent targets, or empty 
    844854     * (e.type == PJSIP_EVENT_UNKNOWN) 
    845      * if this callback is called from within #Call::processRedirect() 
     855     * if this callback is called from within Call::processRedirect() 
    846856     * context. 
    847857     */ 
     
    850860 
    851861/** 
    852  * This structure contains parameters for onCallMediaEvent() callback. 
     862 * This structure contains parameters for Call::onCallMediaEvent() callback. 
    853863 */ 
    854864struct OnCallMediaEventParam 
     
    866876 
    867877/** 
    868  * This structure contains parameters for onCallMediaTransportState() callback. 
     878 * This structure contains parameters for Call::onCallMediaTransportState() 
     879 * callback. 
    869880 */ 
    870881struct OnCallMediaTransportStateParam 
     
    892903 
    893904/** 
    894  * This structure contains parameters for onCreateMediaTransport() callback. 
     905 * This structure contains parameters for Call::onCreateMediaTransport() 
     906 * callback. 
    895907 */ 
    896908struct OnCreateMediaTransportParam 
     
    10931105     * Get media for the specified media index. 
    10941106     * 
    1095      * @psaram med_idx      Media index. 
     1107     * @param med_idx       Media index. 
    10961108     * 
    10971109     * @return              The media or NULL if invalid or inactive. 
     
    11181130     * @return              PJSIP_DIALOG_CAP_SUPPORTED if the specified 
    11191131     *                      capability is explicitly supported, see 
    1120      *                      @pjsip_dialog_cap_status for more info. 
     1132     *                      pjsip_dialog_cap_status for more info. 
    11211133     */ 
    11221134    pjsip_dialog_cap_status remoteHasCap(int htype, 
     
    11261138    /** 
    11271139     * Attach application specific data to the call. Application can then 
    1128      * inspect this data by calling #Call::getUserData(). 
     1140     * inspect this data by calling getUserData(). 
    11291141     * 
    11301142     * @param user_data     Arbitrary data to be attached to the call. 
     
    11341146    /** 
    11351147     * Get user data attached to the call, which has been previously set with 
    1136      * #Call::setUserData(). 
     1148     * setUserData(). 
    11371149     * 
    11381150     * @return              The user data. 
     
    11431155     * Get the NAT type of remote's endpoint. This is a proprietary feature 
    11441156     * of PJSUA-LIB which sends its NAT type in the SDP when \a natTypeInSdp 
    1145      * is set in #UaConfig. 
     1157     * is set in UaConfig. 
    11461158     * 
    11471159     * This function can only be called after SDP has been received from remote, 
     
    11801192     *  - if no call setting is supplied when SDP has to be sent, i.e: answer 
    11811193     *    with status code 183 or 2xx, the default call setting will be used, 
    1182      *    check #CallSetting for its default values. 
     1194     *    check CallSetting for its default values. 
    11831195     * 
    11841196     * @param prm.opt       Optional call setting. 
    1185      * @param prm.statusCode     
    1186      *                      Status code, (100-699). 
     1197     * @param prm.statusCode   Status code, (100-699). 
    11871198     * @param prm.reason    Optional reason phrase. If empty, default text 
    11881199     *                      will be used. 
     
    11971208     * Hangup call by using method that is appropriate according to the 
    11981209     * call state. This function is different than answering the call with 
    1199      * 3xx-6xx response (with #Call::answer()), in that this function 
     1210     * 3xx-6xx response (with answer()), in that this function 
    12001211     * will hangup the call regardless of the state and role of the call, 
    1201      * while #Call::answer() only works with incoming calls on EARLY 
     1212     * while answer() only works with incoming calls on EARLY 
    12021213     * state. 
    12031214     * 
     
    13951406     * 
    13961407     * @param op            The video stream operation to be performed, 
    1397      *                      possible values are #pjsua_call_vid_strm_op. 
     1408     *                      possible values are pjsua_call_vid_strm_op. 
    13981409     * @param param         The parameters for the video stream operation 
    1399      *                      (see #CallVidSetStreamParam). 
     1410     *                      (see CallVidSetStreamParam). 
    14001411     */ 
    14011412    void vidSetStream(pjsua_call_vid_strm_op op, 
     
    14471458     * Notify application when call state has changed. 
    14481459     * Application may then query the call info to get the 
    1449      * detail call states by calling Call::getInfo() function. 
     1460     * detail call states by calling getInfo() function. 
    14501461     * 
    14511462     * @param prm       Callback parameter. 
     
    16391650     *                    no decision can be made immediately (for example 
    16401651     *                    to request confirmation from user). Application 
    1641      *                    then MUST call #Call::processRedirect() 
     1652     *                    then MUST call processRedirect() 
    16421653     *                    to either accept or reject the redirection upon 
    16431654     *                    getting user decision. 
     
    16931704}; 
    16941705 
     1706/** 
     1707 * @}  // PJSUA2_CALL 
     1708 */ 
     1709 
    16951710} // namespace pj 
    16961711 
    1697 /** 
    1698  * @}  // PJSUA2_CALL 
    1699  */ 
    1700  
    17011712#endif  /* __PJSUA2_CALL_HPP__ */ 
    17021713 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/config.hpp

    r4644 r4672  
    2121 
    2222/** 
    23  * @file pjsua2/ua.hpp 
     23 * @file pjsua2/config.hpp 
    2424 * @brief PJSUA2 Base Agent Operation 
    2525 */ 
     
    2828/** 
    2929 * @defgroup PJSUA2_CFG_Compile Compile time settings 
    30  * @ingroup PJSUA2_Ref 
     30 * @ingroup PJSUA2_DS 
    3131 * @{ 
    3232 */ 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/doxygen.hpp

    r4597 r4672  
    2626 
    2727/** 
    28  * @defgroup PJSUA2 PJSUA2: High Level Object Oriented PJSUA API 
    29  * @{ 
    30  * The PJSUA2 API is a new, high-level, object-oriented API that is built 
    31  * on top of PJSUA-LIB API. The PJSUA2 API is implemented with C++ and 
    32  * can be used from other high level languages such as Java and Python. 
    33  * Thanks to <A HREF="http://www.swig.org">SWIG</A>, the API can potentially 
    34  * be used in other high level or scripting languages where SWIG binding is 
    35  * available, such as C#, Perl, PHP, Ruby, and Tcl. 
    36  * 
    37  * This page mostly contains the reference documentation of the API. For 
    38  * more guide on the API, please see the PJSUA2 wiki page: 
    39  * http://trac.pjsip.org/repos/wiki/pjsua2_API 
    40  * @} 
     28@mainpage pjsua2 API 
     29 
     30This documentation contains the API Reference for pjsua2. Please 
     31go to <b>Modules</b> section above for navigation. 
     32 
     33For more info regarding pjsua2, including some tutorials, please 
     34see The PJSIP Book. 
     35*/ 
     36 
     37 
     38/** 
     39 * @defgroup PJSUA2_Ref pjsua2 API Reference 
    4140 */ 
    4241 
    4342/** 
    44  * @defgroup PJSUA2_Ref API Reference 
    45  * @ingroup PJSUA2 
     43 * @defgroup PJSUA2_DS Data Structure 
     44 * @ingroup PJSUA2_Ref 
    4645 */ 
    47  
    4846 
    4947 
  • 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. 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/json.hpp

    r4644 r4672  
    2929#include <string> 
    3030 
     31/** PJSUA2 API is inside pj namespace */ 
     32namespace pj 
     33{ 
     34 
    3135/** 
    3236 * @defgroup PJSUA2_JSON JSON Persistent Support 
     
    3640 */ 
    3741 
    38 /** PJSUA2 API is inside pj namespace */ 
    39 namespace pj 
    40 { 
    4142using std::string; 
    4243 
    43  
     44/** 
     45 * Persistent document (file) with JSON format. 
     46 */ 
    4447class JsonDocument : public PersistentDocument 
    4548{ 
     
    104107 
    105108 
    106 } // namespace pj 
    107  
    108109/** 
    109110 * @}  PJSUA2 
    110111 */ 
    111112 
     113} // namespace pj 
    112114 
    113115 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/media.hpp

    r4669 r4672  
    2828#include <pjsua2/types.hpp> 
    2929 
     30/** PJSUA2 API is inside pj namespace */ 
     31namespace pj 
     32{ 
     33 
    3034/** 
    3135 * @defgroup PJSUA2_MED Media 
     
    3438 */ 
    3539 
    36 /** PJSUA2 API is inside pj namespace */ 
    37 namespace pj 
    38 { 
    3940using std::string; 
    4041using std::vector; 
     
    488489     * function at any time to replace current sound device. 
    489490     * 
    490      * @param capture dev       Device ID of the capture device. 
     491     * @param capture_dev       Device ID of the capture device. 
    491492     */ 
    492493    void setCaptureDev(int capture_dev) const throw(Error); 
     
    10931094typedef void *CodecParam; 
    10941095 
     1096 
     1097/** 
     1098 * @}  // PJSUA2_MED 
     1099 */ 
     1100 
    10951101} // namespace pj 
    10961102 
    1097 /** 
    1098  * @}  // PJSUA2_MED 
    1099  */ 
    1100  
    11011103#endif  /* __PJSUA2_MEDIA_HPP__ */ 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/persistent.hpp

    r4657 r4672  
    2828#include <string> 
    2929#include <vector> 
     30 
     31/** PJSUA2 API is inside pj namespace */ 
     32namespace pj 
     33{ 
    3034 
    3135/** 
     
    4145 */ 
    4246 
    43 /** PJSUA2 API is inside pj namespace */ 
    44 namespace pj 
    45 { 
    4647using std::string; 
    4748using std::vector; 
     
    262263     * 
    263264     * @param name      The name for the value in the container. 
    264      * @param value     The value to be written. 
     265     * @param num       The value to be written. 
    265266     */ 
    266267    void                writeNumber(const string &name, 
     
    271272     * 
    272273     * @param name      The name for the value in the container. 
    273      * @param value     The value to be written. 
     274     * @param num       The value to be written. 
    274275     */ 
    275276    void                writeInt(const string &name, 
     
    298299     * 
    299300     * @param name      The name for the value in the container. 
    300      * @param array     The vector to be written. 
     301     * @param arr       The vector to be written. 
    301302     */ 
    302303    void                writeStringVector(const string &name, 
    303                                           const StringVector &value) 
     304                                          const StringVector &arr) 
    304305                                          throw(Error); 
    305306 
     
    348349struct container_node_internal_data 
    349350{ 
    350     void        *doc; 
    351     void        *data1; 
    352     void        *data2; 
     351    void        *doc;           /**< The document.      */ 
     352    void        *data1;         /**< Internal data 1    */ 
     353    void        *data2;         /**< Internal data 2    */ 
    353354}; 
    354355 
     
    524525     * 
    525526     * @param name      The name for the value in the container. 
    526      * @param value     The value to be written. 
     527     * @param num       The value to be written. 
    527528     */ 
    528529    void                writeNumber(const string &name, 
     
    533534     * 
    534535     * @param name      The name for the value in the container. 
    535      * @param value     The value to be written. 
     536     * @param num       The value to be written. 
    536537     */ 
    537538    void                writeInt(const string &name, 
     
    560561     * 
    561562     * @param name      The name for the value in the container. 
    562      * @param array     The vector to be written. 
     563     * @param arr       The vector to be written. 
    563564     */ 
    564565    void                writeStringVector(const string &name, 
    565                                           const StringVector &value) 
     566                                          const StringVector &arr) 
    566567                                          throw(Error); 
    567568 
     
    598599public: 
    599600    /* internal data */ 
    600     container_node_op *op; 
    601     container_node_internal_data data; 
     601    container_node_op *op;              /**< Method table.      */ 
     602    container_node_internal_data data;  /**< Internal data      */ 
    602603}; 
    603604 
     
    607608 * implementation notes for more info. 
    608609 */ 
     610//! @cond Doxygen_Suppress 
    609611struct container_node_op 
    610612{ 
     
    652654                                         const string &name) 
    653655                                         throw(Error); 
    654  
    655656}; 
    656  
    657657 
    658658/* 
     
    677677#define NODE_WRITE_OBJ(node,item)       node.writeObject(item) 
    678678 
     679//! @endcond 
     680 
     681/** 
     682 * @}  PJSUA2 
     683 */ 
    679684 
    680685} // namespace pj 
    681686 
    682 /** 
    683  * @}  PJSUA2 
    684  */ 
    685  
    686687 
    687688 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/presence.hpp

    r4657 r4672  
    2727#include <pjsua2/siptypes.hpp> 
    2828 
     29/** PJSUA2 API is inside pj namespace */ 
     30namespace pj 
     31{ 
     32 
    2933/** 
    3034 * @defgroup PJSUA2_PRES Presence 
     
    3337 */ 
    3438 
    35 /** PJSUA2 API is inside pj namespace */ 
    36 namespace pj 
    37 { 
    3839using std::string; 
    3940using std::vector; 
     
    170171     
    171172public: 
     173    /** Import from pjsip structure */ 
    172174    void fromPj(const pjsua_buddy_info &pbi); 
    173175}; 
     
    286288 
    287289 
     290/** 
     291 * @}  // PJSUA2_PRES 
     292 */ 
     293 
    288294} // namespace pj 
    289295 
    290 /** 
    291  * @}  // PJSUA2_PRES 
    292  */ 
    293  
    294296#endif  /* __PJSUA2_PRESENCE_HPP__ */ 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/siptypes.hpp

    r4663 r4672  
    3030#include <vector> 
    3131 
    32 /** 
    33  * @defgroup PJSUA2_TYPES Data structure 
    34  * @ingroup PJSUA2_Ref 
    35  * @{ 
    36  */ 
    37  
    3832/** PJSUA2 API is inside pj namespace */ 
    3933namespace pj 
     
    4135 
    4236/** 
     37 * @defgroup PJSUA2_SIP_Types SIP Types 
     38 * @ingroup PJSUA2_DS 
     39 * @{ 
     40 */ 
     41 
     42/** 
    4343 * Credential information. Credential contains information to authenticate 
    4444 * against a service. 
     
    7575    /* 
    7676     * Digest AKA credential information. Note that when AKA credential 
    77      * is being used, the \a data field of this #pjsip_cred_info is 
     77     * is being used, the \a data field of this pjsip_cred_info is 
    7878     * not used, but it still must be initialized to an empty string. 
    79      * Please see \ref PJSIP_AUTH_AKA_API for more information. 
     79     * Please see PJSIP_AUTH_AKA_API for more information. 
    8080     */ 
    8181 
     
    146146 
    147147    /** 
    148      * TLS protocol method from #pjsip_ssl_method. 
     148     * TLS protocol method from pjsip_ssl_method. 
    149149     * 
    150150     * Default is PJSIP_SSL_UNSPECIFIED_METHOD (0), which in turn will 
     
    166166     * verification result: 
    167167     * - If \a verifyServer is disabled, TLS transport will just notify 
    168      *   the application via #pjsip_tp_state_callback with state 
     168     *   the application via pjsip_tp_state_callback with state 
    169169     *   PJSIP_TP_STATE_CONNECTED regardless TLS verification result. 
    170170     * - If \a verifyServer is enabled, TLS transport will be shutdown 
     
    173173     *   error, otherwise PJSIP_TP_STATE_CONNECTED will be notified. 
    174174     * 
    175      * In any cases, application can inspect #pjsip_tls_state_info in the 
     175     * In any cases, application can inspect pjsip_tls_state_info in the 
    176176     * callback to see the verification detail. 
    177177     * 
     
    184184     * verification result: 
    185185     * - If \a verifyClient is disabled, TLS transport will just notify 
    186      *   the application via #pjsip_tp_state_callback with state 
     186     *   the application via pjsip_tp_state_callback with state 
    187187     *   PJSIP_TP_STATE_CONNECTED regardless TLS verification result. 
    188188     * - If \a verifyClient is enabled, TLS transport will be shutdown 
     
    191191     *   error, otherwise PJSIP_TP_STATE_CONNECTED will be notified. 
    192192     * 
    193      * In any cases, application can inspect #pjsip_tls_state_info in the 
     193     * In any cases, application can inspect pjsip_tls_state_info in the 
    194194     * callback to see the verification detail. 
    195195     * 
     
    382382    string                  info; 
    383383 
    384     /** Transport flags (see #pjsip_transport_flags_e). */ 
     384    /** Transport flags (see pjsip_transport_flags_e). */ 
    385385    unsigned                flags; 
    386386 
     
    860860/* Utilities */ 
    861861#ifndef SWIG 
     862//! @cond Doxygen_Suppress 
    862863void readIntVector( ContainerNode &node, 
    863864                    const string &array_name, 
     
    876877                     const string &array_name, 
    877878                     const SipHeaderVector &headers) throw(Error); 
     879//! @endcond 
    878880#endif // SWIG 
    879881 
     882/** 
     883 * @}  PJSUA2 
     884 */ 
     885 
    880886} // namespace pj 
    881887 
    882 /** 
    883  * @}  PJSUA2 
    884  */ 
    885  
    886888 
    887889 
  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/types.hpp

    r4670 r4672  
    3434#include <vector> 
    3535 
    36 /** 
    37  * @defgroup PJSUA2_TYPES Data structure 
    38  * @ingroup PJSUA2_Ref 
    39  * @{ 
    40  */ 
    41  
    4236/** PJSUA2 API is inside pj namespace */ 
    4337namespace pj 
    4438{ 
     39 
     40/** 
     41 * @defgroup PJSUA2_TYPES General Data Structure 
     42 * @ingroup PJSUA2_DS 
     43 * @{ 
     44 */ 
     45 
    4546using std::string; 
    4647using std::vector; 
     
    165166 
    166167#else 
     168    /** Raise Error exception */ 
    167169#   define PJSUA2_RAISE_ERROR(status)           \ 
    168170        PJSUA2_RAISE_ERROR2(status, string()) 
    169171 
     172/** Raise Error exception */ 
    170173#   define PJSUA2_RAISE_ERROR2(status,op)       \ 
    171174        PJSUA2_RAISE_ERROR3(status, op, string()) 
    172175 
     176/** Raise Error exception */ 
    173177#   define PJSUA2_RAISE_ERROR3(status,op,txt)   \ 
    174178        do { \ 
     
    180184#endif 
    181185 
     186/** Raise Error exception if the expression fails */ 
    182187#define PJSUA2_CHECK_RAISE_ERROR2(status, op)   \ 
    183188        do { \ 
     
    187192        } while (0) 
    188193 
     194/** Raise Error exception if the status fails */ 
    189195#define PJSUA2_CHECK_RAISE_ERROR(status)        \ 
    190196        PJSUA2_CHECK_RAISE_ERROR2(status, "") 
    191197 
     198/** Raise Error exception if the expression fails */ 
    192199#define PJSUA2_CHECK_EXPR(expr)                 \ 
    193200        do { \ 
     
    197204 
    198205////////////////////////////////////////////////////////////////////////////// 
    199  
     206/** 
     207 * Version information. 
     208 */ 
    200209struct Version 
    201210{ 
     
    247256}; 
    248257 
     258/** 
     259 * @}  PJSUA2 
     260 */ 
     261 
    249262} // namespace pj 
    250263 
    251 /** 
    252  * @}  PJSUA2 
    253  */ 
    254  
    255264 
    256265 
  • pjproject/branches/projects/pjsua2/pjsip/src/pjsua2/call.cpp

    r4670 r4672  
    685685                if (pj_ci.media[mi].stream.aud.conf_slot != PJSUA_INVALID_ID) 
    686686                { 
    687                     Endpoint::instance().addMedia((AudioMedia &)*aud_med); 
     687                    Endpoint::instance().mediaAdd((AudioMedia &)*aud_med); 
    688688                } else { 
    689                     Endpoint::instance().removeMedia((AudioMedia &)*aud_med); 
     689                    Endpoint::instance().mediaRemove((AudioMedia &)*aud_med); 
    690690                } 
    691691            } 
  • pjproject/branches/projects/pjsua2/pjsip/src/pjsua2/endpoint.cpp

    r4670 r4672  
    13671367} 
    13681368 
    1369 void Endpoint::addMedia(AudioMedia &media) 
     1369void Endpoint::mediaAdd(AudioMedia &media) 
    13701370{ 
    13711371    if (mediaExists(media)) 
     
    13751375} 
    13761376 
    1377 void Endpoint::removeMedia(AudioMedia &media) 
     1377void Endpoint::mediaRemove(AudioMedia &media) 
    13781378{ 
    13791379    AudioMediaVector::iterator it = std::find(mediaList.begin(), 
  • pjproject/branches/projects/pjsua2/pjsip/src/pjsua2/media.cpp

    r4670 r4672  
    146146    } 
    147147 
    148     Endpoint::instance().addMedia(*this); 
     148    Endpoint::instance().mediaAdd(*this); 
    149149} 
    150150 
     
    162162    id = PJSUA_INVALID_ID; 
    163163 
    164     Endpoint::instance().removeMedia(*this); 
     164    Endpoint::instance().mediaRemove(*this); 
    165165} 
    166166 
Note: See TracChangeset for help on using the changeset viewer.