Changeset 1748


Ignore:
Timestamp:
Jan 25, 2008 4:06:33 PM (16 years ago)
Author:
bennylp
Message:

Fixed doxygen comments everywhere

Location:
pjproject/trunk
Files:
32 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/pjlib-util/docs/doxygen.cfg

    r754 r1748  
    844844PREDEFINED             = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \ 
    845845                         PJ_IDEF(x)=x PJ_INLINE(x)=x \ 
     846                         PJ_DECL_DATA(x)=x \ 
    846847                         PJ_DECL_NO_RETURN(x)=x \ 
     848                         PJ_NO_RETURN=x \ 
    847849                         PJ_HAS_HIGH_RES_TIMER=1 \ 
    848850                         PJ_LOG_MAX_LEVEL=4 \ 
    849851                         PJ_HAS_SEMAPHORE=1 \ 
    850                          PJ_HAS_EVENT_OBJ=1 
     852                         PJ_HAS_EVENT_OBJ=1 \ 
     853                         PJ_HAS_TCP=1 
     854 
    851855 
    852856# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  

  • pjproject/trunk/pjlib-util/include/pjlib-util/md5.h

    r1374 r1748  
    3939typedef struct pj_md5_context 
    4040{ 
    41         pj_uint32_t buf[4]; 
    42         pj_uint32_t bits[2]; 
    43         pj_uint8_t  in[64]; 
     41        pj_uint32_t buf[4];     /**< buf    */ 
     42        pj_uint32_t bits[2];    /**< bits   */ 
     43        pj_uint8_t  in[64];     /**< in     */ 
    4444} pj_md5_context; 
    4545 

  • pjproject/trunk/pjlib-util/include/pjlib-util/scanner_cis_uint.h

    r1374 r1748  
    4646typedef struct pj_cis_t 
    4747{ 
    48     PJ_CIS_ELEM_TYPE    cis_buf[256]; 
     48    PJ_CIS_ELEM_TYPE    cis_buf[256];   /**< Internal buffer.   */ 
    4949} pj_cis_t; 
    5050 

  • pjproject/trunk/pjlib-util/include/pjlib-util/sha1.h

    r1374 r1748  
    3838typedef struct pj_sha1_context 
    3939{ 
    40     pj_uint32_t state[5]; 
    41     pj_uint32_t count[2]; 
    42     pj_uint8_t  buffer[64]; 
     40    pj_uint32_t state[5];       /**< State  */ 
     41    pj_uint32_t count[2];       /**< Count  */ 
     42    pj_uint8_t  buffer[64];     /**< Buffer */ 
    4343} pj_sha1_context; 
    4444 

  • pjproject/trunk/pjlib-util/include/pjlib-util/srv_resolver.h

    r1590 r1748  
    3333 * @{ 
    3434 * 
    35  * \subsection PJ_DNS_SRV_RESOLVER_INTRO DNS SRV Resolution Helper 
     35 * \section PJ_DNS_SRV_RESOLVER_INTRO DNS SRV Resolution Helper 
    3636 * 
    3737 * This module provides an even higher layer of abstraction for the DNS 

  • pjproject/trunk/pjlib-util/include/pjlib-util/xml.h

    r1374 r1748  
    9595 */ 
    9696PJ_DECL(int) pj_xml_print( const pj_xml_node *node, char *buf, pj_size_t len, 
    97                            pj_bool_t include_prolog); 
     97                           pj_bool_t prolog); 
    9898 
    9999/** 
    … …  
    124124 * @param pool      Pool. 
    125125 * @param name      Attribute name. 
    126  * @param attr      Attribute value. 
     126 * @param value     Attribute value. 
    127127 * 
    128128 * @return          The new XML attribute. 
    … …  
    162162 * 
    163163 * @param parent    Parent node. 
     164 * @param node      node->next is the starting point. 
    164165 * @param name      Node name to find. 
    165166 * 
    … …  
    185186 * Find a direct child node with the specified name and match the function. 
    186187 * 
    187  * @param node      Parent node. 
     188 * @param parent    Parent node. 
    188189 * @param name      Optional name. 
    189190 * @param data      Data to be passed to matching function. 

  • pjproject/trunk/pjlib/docs/doxygen.cfg

    r1595 r1748  
    844844PREDEFINED             = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \ 
    845845                         PJ_IDEF(x)=x PJ_INLINE(x)=x \ 
     846                         PJ_DECL_DATA(x)=x \ 
    846847                         PJ_DECL_NO_RETURN(x)=x \ 
     848                         PJ_NO_RETURN=x \ 
    847849                         PJ_HAS_HIGH_RES_TIMER=1 \ 
    848850                         PJ_LOG_MAX_LEVEL=4 \ 

  • pjproject/trunk/pjlib/include/pj/config.h

    r1649 r1748  
    450450 
    451451/** 
    452  * \def PJ_HAS_TCP 
    453452 * Support TCP in the library. 
    454453 * Disabling TCP will reduce the footprint slightly (about 6KB). 
    … …  
    461460 
    462461/** 
    463  * \def PJ_HAS_IPV6 
    464462 * Support IPv6 in the library. If this support is disabled, some IPv6  
    465463 * related functions will return PJ_EIPV6NOTSUP. 
    … …  
    847845 */ 
    848846/** 
     847 * @def PJ_IDECL_NO_RETURN(type) 
     848 * @param type The return type of the function. 
     849 * Declare an inline function that will not return. 
     850 */ 
     851/** 
    849852 * @def PJ_BEGIN_DECL 
    850853 * Mark beginning of declaration section in a header file. 

  • pjproject/trunk/pjlib/include/pj/errno.h

    r1601 r1748  
    112112                               char *buf, pj_size_t bufsize); 
    113113 
    114 typedef pj_str_t (*pjsip_error_callback)(pj_status_t, char*, pj_size_t); 
     114/** 
     115 * Type of callback to be specified in #pj_register_strerror() 
     116 * 
     117 * @param e         The error code to lookup. 
     118 * @param msg       Buffer to store the error message. 
     119 * @param max       Length of the buffer. 
     120 * 
     121 * @return          The error string. 
     122 */ 
     123typedef pj_str_t (*pj_error_callback)(pj_status_t e, char *msg, pj_size_t max); 
     124 
     125 
    115126/** 
    116127 * Register strerror message handler for the specified error space. 
    … …  
    134145PJ_DECL(pj_status_t) pj_register_strerror(pj_status_t start_code, 
    135146                                          pj_status_t err_space, 
    136                                           pjsip_error_callback f); 
     147                                          pj_error_callback f); 
    137148 
    138149/** 

  • pjproject/trunk/pjlib/include/pj/ioqueue.h

    r1405 r1748  
    167167 
    168168    /** 
    169      * This callback is called when #pj_ioqueue_write or #pj_ioqueue_sendto 
     169     * This callback is called when #pj_ioqueue_send or #pj_ioqueue_sendto 
    170170     * completes. 
    171171     * 

  • pjproject/trunk/pjlib/include/pj/pool.h

    r1417 r1748  
    613613 
    614614/** 
     615 * \def PJ_NO_MEMORY_EXCEPTION 
    615616 * This constant denotes the exception number that will be thrown by default 
    616617 * memory factory policy when memory allocation fails. 

  • pjproject/trunk/pjlib/src/pj/errno.c

    r1601 r1748  
    107107PJ_DEF(pj_status_t) pj_register_strerror( pj_status_t start, 
    108108                                          pj_status_t space, 
    109                                           pjsip_error_callback f) 
     109                                          pj_error_callback f) 
    110110{ 
    111111    unsigned i; 

  • pjproject/trunk/pjmedia/docs/doxygen.cfg

    r783 r1748  
    844844PREDEFINED             = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \ 
    845845                         PJ_IDEF(x)=x PJ_INLINE(x)=x \ 
    846                          PJ_BEGIN_DECL= PJ_END_DECL= \ 
    847                          PJMEDIA_HAS_MP3_WRITER=1 
     846                         PJ_DECL_DATA(x)=x \ 
     847                         PJ_DECL_NO_RETURN(x)=x \ 
     848                         PJ_NO_RETURN=x \ 
     849                         PJ_HAS_HIGH_RES_TIMER=1 \ 
     850                         PJ_LOG_MAX_LEVEL=4 \ 
     851                         PJ_HAS_SEMAPHORE=1 \ 
     852                         PJ_HAS_EVENT_OBJ=1 \ 
     853                         PJ_HAS_TCP=1 \ 
     854                         PJMEDIA_HAS_SRTP=1 
    848855 
    849856# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then  

  • pjproject/trunk/pjmedia/include/pjmedia/transport.h

    r1735 r1748  
    5757 * #pjmedia_transport_op directly. 
    5858 * 
     59 * The connection between \ref PJMED_STRM and media transport is shown in 
     60 * the diagram below: 
     61 
     62   \image html media-transport.PNG 
     63 
     64 
    5965 * \section PJMEDIA_TRANSPORT_H_USING Using the Media Transport 
    6066 * 
    … …  
    136142 * 
    137143 * 
     144 * \section PJMEDIA_TRANSPORT_H_EXT Media Transport Extended API 
     145  
     146   Apart from the basic interface above, the media transport provides some 
     147   more APIs: 
     148 
     149    - pjmedia_transport_media_create() 
     150   \n 
     151      This API is provided to allow the media transport to add more information 
     152      in the SDP offer, before the offer is sent to remote. Additionally, for  
     153      answerer side, this callback allows the media transport to reject the  
     154      offer before this offer is processed by the SDP negotiator.  
     155 
     156    - pjmedia_transport_media_start() 
     157    \n 
     158      This API should be called after offer and answer are negotiated, and  
     159      both SDPs are available, and before the media is started. For answerer 
     160      side, this callback will be called before the answer is sent to remote, 
     161      to allow media transport to put additional info in the SDP. For  
     162      offerer side, this callback will be called after SDP answer is  
     163      received. In this callback, the media transport has the final chance  
     164      to negotiate/validate the offer and answer before media is really  
     165      started (and answer is sent, for answerer side).  
     166 
     167    - pjmedia_transport_media_stop() 
     168    \n 
     169      This API should be called when the media is stopped, to allow the media 
     170      transport to release its resources.  
     171 
     172    - pjmedia_transport_simulate_lost() 
     173    \n 
     174      This API can be used to instruct media transport to simulate packet lost 
     175      on a particular direction. 
     176 
    138177 * \section PJMEDIA_TRANSPORT_H_IMPL Implementing Media Transport 
    139178 * 
    … …  
    169208#include <pjmedia/sdp.h> 
    170209 
    171 /* 
     210/** 
    172211 * Forward declaration for media transport. 
    173212 */ 
    … …  
    459498 * Remote SDP might be needed as reference when application is in deciding 
    460499 * side of negotiation (callee side), otherwise it should be NULL. 
     500 * 
     501 * This API is provided to allow the media transport to add more information 
     502 * in the SDP offer, before the offer is sent to remote. Additionally, for  
     503 * answerer side, this callback allows the media transport to reject the  
     504 * offer before this offer is processed by the SDP negotiator.  
     505 * 
    461506 * This is just a simple wrapper which calls <tt>media_create()</tt> member  
    462507 * of the transport. 
    … …  
    466511 * @param sdp_local     Local SDP. 
    467512 * @param sdp_remote    Remote SDP. 
     513 * @param media_index   Media index in SDP. 
    468514 * 
    469515 * @return              PJ_SUCCESS on success, or the appropriate error code. 
    … …  
    481527/** 
    482528 * Start the transport with regards to SDP negotiation result.  
     529 * This API should be called after offer and answer are negotiated, and  
     530 * both SDPs are available, and before the media is started. For answerer 
     531 * side, this callback will be called before the answer is sent to remote, 
     532 * to allow media transport to put additional info in the SDP. For  
     533 * offerer side, this callback will be called after SDP answer is  
     534 * received. In this callback, the media transport has the final chance  
     535 * to negotiate/validate the offer and answer before media is really  
     536 * started (and answer is sent, for answerer side).  
     537 * 
    483538 * This is just a simple wrapper which calls <tt>media_start()</tt> member  
    484539 * of the transport. 
    … …  
    504559/** 
    505560 * Stop the transport.  
     561 * This API should be called when the media is stopped, to allow the media 
     562 * transport to release its resources.  
     563 * 
    506564 * This is just a simple wrapper which calls <tt>media_stop()</tt> member  
    507565 * of the transport. 

  • pjproject/trunk/pjmedia/include/pjmedia/transport_srtp.h

    r1735 r1748  
    2222/** 
    2323 * @file srtp.h 
    24  * @brief transport SRTP encapsulates secure media transport. 
     24 * @brief Secure RTP (SRTP) transport. 
    2525 */ 
    2626 
    2727#include <pjmedia/transport.h> 
    2828 
     29 
     30/** 
     31 * @defgroup PJMEDIA_TRANSPORT_SRTP Secure RTP (SRTP) Transport Adapter 
     32 * @ingroup PJMEDIA_TRANSPORT 
     33 * @brief Media transport adapter to add SRTP feature to existing transports 
     34 * @{ 
     35 * 
     36 * This module implements SRTP as described by RFC 3711, using RFC 4568 as 
     37 * key exchange method. It implements \ref PJMEDIA_TRANSPORT_H to integrate 
     38 * with the rest of PJMEDIA framework. 
     39 * 
     40 * As we know, media transport is separated from the stream object (which  
     41 * does the encoding/decoding of PCM frames, (de)packetization of RTP/RTCP  
     42 * packets, and de-jitter buffering). The connection between stream and media 
     43 * transport is established when the stream is created (we need to specify  
     44 * media transport during stream creation), and the interconnection can be  
     45 * depicted from the diagram below: 
     46 * 
     47   \image html media-transport.PNG 
     48 
     49 * I think the diagram above is self-explanatory. 
     50 * 
     51 * SRTP functionality is implemented as some kind of "adapter", which is  
     52 * plugged between the stream and the actual media transport that does  
     53 * sending/receiving RTP/RTCP packets. When SRTP is used, the interconnection 
     54 * between stream and transport is like the diagram below: 
     55 * 
     56    \image html media-srtp-transport.PNG 
     57 
     58 * So to stream, the SRTP transport behaves as if it is a media transport  
     59 * (because it is a media transport), and to the media transport it behaves 
     60 * as if it is a stream. The SRTP object then forwards RTP packets back and 
     61 * forth between stream and the actual transport, encrypting/decrypting  
     62 * the RTP/RTCP packets as necessary. 
     63 *  
     64 * The neat thing about this design is the SRTP "adapter" then can be used  
     65 * to encrypt any kind of media transports. We currently have UDP and ICE  
     66 * media transports that can benefit SRTP, and we could add SRTP to any  
     67 * media transports that will be added in the future.  
     68 */ 
    2969 
    3070PJ_BEGIN_DECL 
    … …  
    5696    pj_str_t    name; 
    5797 
    58     /* Flags, bitmask from #pjmedia_srtp_crypto_option */ 
     98    /** Flags, bitmask from #pjmedia_srtp_crypto_option */ 
    5999    unsigned    flags; 
    60100 
    … …  
    169209 */ 
    170210PJ_DECL(pj_status_t) pjmedia_transport_srtp_start( 
    171                                             pjmedia_transport *tp, 
     211                                            pjmedia_transport *srtp, 
    172212                                            const pjmedia_srtp_crypto *tx, 
    173213                                            const pjmedia_srtp_crypto *rx); 
    … …  
    182222 * @see #pjmedia_transport_srtp_start()  
    183223 */ 
    184 PJ_DECL(pj_status_t) pjmedia_transport_srtp_stop(pjmedia_transport *tp); 
     224PJ_DECL(pj_status_t) pjmedia_transport_srtp_stop(pjmedia_transport *srtp); 
    185225 
    186226 
    … …  
    193233 */ 
    194234PJ_DECL(pjmedia_transport*) pjmedia_transport_srtp_get_member( 
    195                                                     pjmedia_transport *tp); 
     235                                                    pjmedia_transport *srtp); 
    196236 
    197237 
    198238PJ_END_DECL 
    199239 
     240/** 
     241 * @} 
     242 */ 
     243 
    200244#endif /* __PJMEDIA_TRANSPORT_SRTP_H__ */ 

  • pjproject/trunk/pjmedia/src/pjmedia/transport_udp.c

    r1735 r1748  
    749749    PJ_UNUSED_ARG(sdp_local); 
    750750    PJ_UNUSED_ARG(sdp_remote); 
     751    PJ_UNUSED_ARG(media_index); 
    751752 
    752753    return PJ_SUCCESS; 

  • pjproject/trunk/pjsip/docs/doxygen.cfg

    r690 r1748  
    368368# subdirectory from a directory tree whose root is specified with the INPUT tag. 
    369369 
    370 EXCLUDE                = *_i.h 
     370EXCLUDE                = *_i.h pjsua_internal.h 
    371371 
    372372# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories  
    … …  
    845845 
    846846PREDEFINED             = PJ_DECL(x)=x PJ_DEF(x)=x PJ_IDECL(x)=x \ 
    847                          PJ_IDEF(x)=x PJ_INLINE(x)=x 
     847                         PJ_IDEF(x)=x PJ_INLINE(x)=x PJ_DECL_DATA(x)=x \ 
     848                         PJMEDIA_HAS_SRTP=1 
    848849 
    849850 

  • pjproject/trunk/pjsip/include/pjsip-simple/evsub.h

    r1417 r1748  
    2121 
    2222/** 
    23  * @file event_notify.h 
     23 * @file evsub.h 
    2424 * @brief SIP Specific Event Notification Extension (RFC 3265) 
    2525 */ 
    … …  
    133133     * However, implementation MUST send NOTIFY request upon receiving this 
    134134     * callback. The suggested behavior is to call  
    135      * #pjsip_evsub_last_notify(), since this function takes care 
     135     * #pjsip_evsub_current_notify(), since this function takes care 
    136136     * about unsubscription request and calculates the appropriate expiration 
    137137     * interval. 

  • pjproject/trunk/pjsip/include/pjsip-simple/evsub_msg.h

    r1417 r1748  
    2121 
    2222/** 
    23  * @file event_notify_msg.h 
     23 * @file evsub_msg.h 
    2424 * @brief SIP Event Notification Headers (RFC 3265) 
    2525 */ 

  • pjproject/trunk/pjsip/include/pjsip-ua/sip_inv.h

    r1733 r1748  
    496496 * Create the initial response message for the incoming INVITE request in 
    497497 * rdata with  status code st_code and optional status text st_text. Use 
    498  * #pjsip_answer() to create subsequent response message. 
     498 * #pjsip_inv_answer() to create subsequent response message. 
    499499 */ 
    500500PJ_DECL(pj_status_t) pjsip_inv_initial_answer(  pjsip_inv_session *inv, 

  • pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

    r1561 r1748  
    2121 
    2222/** 
    23  * @file sip_reg.h 
     23 * @file sip_regc.h 
    2424 * @brief SIP Registration Client 
    2525 */ 

  • pjproject/trunk/pjsip/include/pjsip/sip_auth.h

    r1561 r1748  
    3131 
    3232/** 
    33  * @addtogroup PJSIP_AUTH Authentication Framework 
     33 * @addtogroup PJSIP_AUTH 
    3434 * @ingroup PJSIP_CORE 
    3535 * @brief Client and server side authentication framework. 

  • pjproject/trunk/pjsip/include/pjsip/sip_auth_parser.h

    r974 r1748  
    2121 
    2222/** 
    23  * @file pjsip_auth_parser.h 
     23 * @file sip_auth_parser.h 
    2424 * @brief SIP Authorization Parser Module. 
    2525 */ 

  • pjproject/trunk/pjsip/include/pjsip/sip_config.h

    r1575 r1748  
    352352 * Note that even when this setting is enabled, asynchronous DNS resolution 
    353353 * will only be done when application calls #pjsip_endpt_create_resolver(), 
    354  * configure the nameservers with #pj_dns_resolver_set_ns(), and configure 
     354 * configure the nameservers with pj_dns_resolver_set_ns(), and configure 
    355355 * the SIP endpoint's DNS resolver with #pjsip_endpt_set_resolver(). If 
    356356 * these steps are not followed, the domain will be resolved with normal 

  • pjproject/trunk/pjsip/include/pjsip/sip_dialog.h

    r1537 r1748  
    2222 
    2323/** 
    24  * @file dialog.h 
     24 * @file sip_dialog.h 
    2525 * @brief SIP Dialog abstraction 
    2626 */ 

  • pjproject/trunk/pjsip/include/pjsip/sip_endpoint.h

    r1098 r1748  
    225225 
    226226/** 
    227  * Create a new transaction. After creating the transaction, application MUST 
    228  * initialize the transaction as either UAC or UAS (by calling 
    229  * #pjsip_tsx_init_uac or #pjsip_tsx_init_uas), then must register the  
    230  * transaction to endpoint with #pjsip_endpt_register_tsx. 
    231  * This function, like all other endpoint functions, is thread safe. 
    232  * 
    233  * @param endpt     The SIP endpoint. 
    234  * @param p_tsx     Pointer to receive the transaction. 
    235  * 
    236  * @return          PJ_SUCCESS or the appropriate error code. 
    237  */ 
    238 PJ_DECL(pj_status_t) pjsip_endpt_create_tsx(pjsip_endpoint *endpt, 
    239                                             pjsip_transaction **p_tsx); 
    240  
    241 /** 
    242227 * Find transaction in endpoint's transaction table by the transaction's key. 
    243228 * This function normally is only used by modules. The key for a transaction 

  • pjproject/trunk/pjsip/include/pjsip/sip_msg.h

    r1461 r1748  
    10331033    unsigned    count; 
    10341034 
    1035     /**< Tags/elements. */ 
     1035    /** Tags/elements. */ 
    10361036    pj_str_t    values[PJSIP_GENERIC_ARRAY_MAX_COUNT]; 
    10371037 

  • pjproject/trunk/pjsip/include/pjsip/sip_resolve.h

    r974 r1748  
    210210 * internally by pjsip_endpoint instance. 
    211211 * 
    212  * @param pf        The Pool Factory. 
     212 * @param pool      Pool to allocate memory from. 
    213213 * @param p_res     Pointer to receive SIP resolver instance. 
    214214 * 

  • pjproject/trunk/pjsip/include/pjsip/sip_transaction.h

    r1594 r1748  
    361361PJ_DECL(void) pjsip_tsx_layer_dump(pj_bool_t detail); 
    362362 
    363 /* 
     363/** 
    364364 * Get the string name for the state. 
     365 * @param state State 
    365366 */ 
    366367PJ_DECL(const char *) pjsip_tsx_state_str(pjsip_tsx_state_e state); 
    367368 
    368 /* 
     369/** 
    369370 * Get the role name. 
     371 * @param role  Role. 
    370372 */ 
    371373PJ_DECL(const char *) pjsip_role_name(pjsip_role_e role); 

  • pjproject/trunk/pjsip/include/pjsip/sip_transport.h

    r1602 r1748  
    920920 * 
    921921 *****************************************************************************/ 
    922 typedef void (*pjsip_rx_callback)(pjsip_endpoint*, pj_status_t, pjsip_rx_data *); 
    923 typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint*, pjsip_tx_data*); 
     922 
     923/** 
     924 * Type of callback to be called when transport manager receives incoming 
     925 * SIP message. 
     926 * 
     927 * @param ep        Endpoint. 
     928 * @param status    Receiption status. 
     929 * @param rd        Received packet. 
     930 */ 
     931typedef void (*pjsip_rx_callback)(pjsip_endpoint *ep, pj_status_t status,  
     932                                  pjsip_rx_data *rd); 
     933 
     934/** 
     935 * Type of callback to be called before transport manager is about 
     936 * to transmit SIP message. 
     937 * 
     938 * @param ep        Endpoint. 
     939 * @param td        Transmit data. 
     940 */ 
     941typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint *ep, pjsip_tx_data*td); 
     942 
    924943/** 
    925944 * Create a transport manager. Normally application doesn't need to call 

  • pjproject/trunk/pjsip/include/pjsip/sip_util.h

    r1388 r1748  
    260260 
    261261 
    262 typedef void (*pjsip_send_callback)(pjsip_send_state*, pj_ssize_t sent, 
     262/** 
     263 * Declaration for callback function to be specified in  
     264 * #pjsip_endpt_send_request_stateless(), #pjsip_endpt_send_response(), or 
     265 * #pjsip_endpt_send_response2(). 
     266 * 
     267 * @param st        Structure to keep transmission state. 
     268 * @param sent      Number of bytes sent. 
     269 * @param cont      When current transmission fails, specify whether 
     270 *                  the function should fallback to next destination. 
     271 */ 
     272typedef void (*pjsip_send_callback)(pjsip_send_state *st, pj_ssize_t sent, 
    263273                                    pj_bool_t *cont); 
    264274 
    … …  
    518528                                          pjsip_transaction **p_tsx ); 
    519529 
    520 typedef void (*pjsip_endpt_send_callback)(void*, pjsip_event*); 
     530/** 
     531 * Type of callback to be specified in #pjsip_endpt_send_request(). 
     532 * 
     533 * @param token     The token that was given in #pjsip_endpt_send_request() 
     534 * @param e         Completion event. 
     535 */ 
     536typedef void (*pjsip_endpt_send_callback)(void *token, pjsip_event *e); 
     537 
    521538/** 
    522539 * Send outgoing request and initiate UAC transaction for the request. 

  • pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

    r1735 r1748  
    11051105 
    11061106 
    1107 /* The implementation has been moved to sip_auth.h */ 
     1107/** The implementation has been moved to sip_auth.h */ 
    11081108#define pjsip_cred_dup  pjsip_cred_info_dup 
    11091109 
    … …  
    11981198 
    11991199 
    1200 /* Forward declaration */ 
     1200/** Forward declaration */ 
    12011201typedef struct pjsua_media_config pjsua_media_config; 
    12021202 
    … …  
    33943394 * session immediately. 
    33953395 * 
    3396  * @param buddy)cfg     Buddy configuration. 
     3396 * @param buddy_cfg     Buddy configuration. 
    33973397 * @param p_buddy_id    Pointer to receive buddy ID. 
    33983398 * 
    … …  
    44504450 * @param tail_ms       The tail length, in miliseconds. Set to zero to 
    44514451 *                      disable AEC. 
    4452  * @param options       Options to be passed to #pjmedia_echo_create(). 
     4452 * @param options       Options to be passed to pjmedia_echo_create(). 
    44534453 *                      Normally the value should be zero. 
    44544454 * 
Note: See TracChangeset for help on using the changeset viewer.