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/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 
Note: See TracChangeset for help on using the changeset viewer.