diff options
author | Benny Prijono <bennylp@teluu.com> | 2008-01-25 16:06:33 +0000 |
---|---|---|
committer | Benny Prijono <bennylp@teluu.com> | 2008-01-25 16:06:33 +0000 |
commit | d583515e9daac73925c0cb1f617aa124666e5b34 (patch) | |
tree | c3c741cc68ecba2e1f414dee164d3c8e9a4e1a03 /pjsip/include | |
parent | 1357c18f2e4cb7f2d9bddf1afb3603991b5ca08b (diff) |
Fixed doxygen comments everywhere
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1748 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjsip/include')
-rw-r--r-- | pjsip/include/pjsip-simple/evsub.h | 4 | ||||
-rw-r--r-- | pjsip/include/pjsip-simple/evsub_msg.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip-ua/sip_inv.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip-ua/sip_regc.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_auth.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_auth_parser.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_config.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_dialog.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_endpoint.h | 15 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_msg.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_resolve.h | 2 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_transaction.h | 6 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_transport.h | 23 | ||||
-rw-r--r-- | pjsip/include/pjsip/sip_util.h | 21 | ||||
-rw-r--r-- | pjsip/include/pjsua-lib/pjsua.h | 8 |
15 files changed, 59 insertions, 36 deletions
diff --git a/pjsip/include/pjsip-simple/evsub.h b/pjsip/include/pjsip-simple/evsub.h index 1c3ee97c..047952b7 100644 --- a/pjsip/include/pjsip-simple/evsub.h +++ b/pjsip/include/pjsip-simple/evsub.h @@ -20,7 +20,7 @@ #define __PJSIP_SIMPLE_EVSUB_H__ /** - * @file event_notify.h + * @file evsub.h * @brief SIP Specific Event Notification Extension (RFC 3265) */ @@ -132,7 +132,7 @@ struct pjsip_evsub_user * * However, implementation MUST send NOTIFY request upon receiving this * callback. The suggested behavior is to call - * #pjsip_evsub_last_notify(), since this function takes care + * #pjsip_evsub_current_notify(), since this function takes care * about unsubscription request and calculates the appropriate expiration * interval. */ diff --git a/pjsip/include/pjsip-simple/evsub_msg.h b/pjsip/include/pjsip-simple/evsub_msg.h index f1c3f4b7..520a0f9a 100644 --- a/pjsip/include/pjsip-simple/evsub_msg.h +++ b/pjsip/include/pjsip-simple/evsub_msg.h @@ -20,7 +20,7 @@ #define __PJSIP_SIMPLE_EVENT_NOTIFY_MSG_H__ /** - * @file event_notify_msg.h + * @file evsub_msg.h * @brief SIP Event Notification Headers (RFC 3265) */ #include <pjsip/sip_msg.h> diff --git a/pjsip/include/pjsip-ua/sip_inv.h b/pjsip/include/pjsip-ua/sip_inv.h index bfcc11c3..448718dd 100644 --- a/pjsip/include/pjsip-ua/sip_inv.h +++ b/pjsip/include/pjsip-ua/sip_inv.h @@ -495,7 +495,7 @@ PJ_DECL(pj_status_t) pjsip_inv_invite( pjsip_inv_session *inv, /** * Create the initial response message for the incoming INVITE request in * rdata with status code st_code and optional status text st_text. Use - * #pjsip_answer() to create subsequent response message. + * #pjsip_inv_answer() to create subsequent response message. */ PJ_DECL(pj_status_t) pjsip_inv_initial_answer( pjsip_inv_session *inv, pjsip_rx_data *rdata, diff --git a/pjsip/include/pjsip-ua/sip_regc.h b/pjsip/include/pjsip-ua/sip_regc.h index 62d2336f..03c71d9b 100644 --- a/pjsip/include/pjsip-ua/sip_regc.h +++ b/pjsip/include/pjsip-ua/sip_regc.h @@ -20,7 +20,7 @@ #define __PJSIP_SIP_REG_H__ /** - * @file sip_reg.h + * @file sip_regc.h * @brief SIP Registration Client */ diff --git a/pjsip/include/pjsip/sip_auth.h b/pjsip/include/pjsip/sip_auth.h index 155c180c..c6b32dd0 100644 --- a/pjsip/include/pjsip/sip_auth.h +++ b/pjsip/include/pjsip/sip_auth.h @@ -30,7 +30,7 @@ PJ_BEGIN_DECL /** - * @addtogroup PJSIP_AUTH Authentication Framework + * @addtogroup PJSIP_AUTH * @ingroup PJSIP_CORE * @brief Client and server side authentication framework. */ diff --git a/pjsip/include/pjsip/sip_auth_parser.h b/pjsip/include/pjsip/sip_auth_parser.h index 8aaa8461..791bfce1 100644 --- a/pjsip/include/pjsip/sip_auth_parser.h +++ b/pjsip/include/pjsip/sip_auth_parser.h @@ -20,7 +20,7 @@ #define __PJSIP_AUTH_SIP_AUTH_PARSER_H__ /** - * @file pjsip_auth_parser.h + * @file sip_auth_parser.h * @brief SIP Authorization Parser Module. */ diff --git a/pjsip/include/pjsip/sip_config.h b/pjsip/include/pjsip/sip_config.h index 3809ff3c..e72ab394 100644 --- a/pjsip/include/pjsip/sip_config.h +++ b/pjsip/include/pjsip/sip_config.h @@ -351,7 +351,7 @@ * * Note that even when this setting is enabled, asynchronous DNS resolution * will only be done when application calls #pjsip_endpt_create_resolver(), - * configure the nameservers with #pj_dns_resolver_set_ns(), and configure + * configure the nameservers with pj_dns_resolver_set_ns(), and configure * the SIP endpoint's DNS resolver with #pjsip_endpt_set_resolver(). If * these steps are not followed, the domain will be resolved with normal * pj_gethostbyname() function. diff --git a/pjsip/include/pjsip/sip_dialog.h b/pjsip/include/pjsip/sip_dialog.h index b11ba4c8..c8711c46 100644 --- a/pjsip/include/pjsip/sip_dialog.h +++ b/pjsip/include/pjsip/sip_dialog.h @@ -21,7 +21,7 @@ /** - * @file dialog.h + * @file sip_dialog.h * @brief SIP Dialog abstraction */ diff --git a/pjsip/include/pjsip/sip_endpoint.h b/pjsip/include/pjsip/sip_endpoint.h index f285ef8f..baf59007 100644 --- a/pjsip/include/pjsip/sip_endpoint.h +++ b/pjsip/include/pjsip/sip_endpoint.h @@ -224,21 +224,6 @@ PJ_DECL(void) pjsip_endpt_release_pool( pjsip_endpoint *endpt, pj_pool_t *pool ); /** - * Create a new transaction. After creating the transaction, application MUST - * initialize the transaction as either UAC or UAS (by calling - * #pjsip_tsx_init_uac or #pjsip_tsx_init_uas), then must register the - * transaction to endpoint with #pjsip_endpt_register_tsx. - * This function, like all other endpoint functions, is thread safe. - * - * @param endpt The SIP endpoint. - * @param p_tsx Pointer to receive the transaction. - * - * @return PJ_SUCCESS or the appropriate error code. - */ -PJ_DECL(pj_status_t) pjsip_endpt_create_tsx(pjsip_endpoint *endpt, - pjsip_transaction **p_tsx); - -/** * Find transaction in endpoint's transaction table by the transaction's key. * This function normally is only used by modules. The key for a transaction * can be created by calling #pjsip_tsx_create_key. diff --git a/pjsip/include/pjsip/sip_msg.h b/pjsip/include/pjsip/sip_msg.h index 34bd996e..8a202c4b 100644 --- a/pjsip/include/pjsip/sip_msg.h +++ b/pjsip/include/pjsip/sip_msg.h @@ -1032,7 +1032,7 @@ typedef struct pjsip_generic_array_hdr /** Number of tags/elements. */ unsigned count; - /**< Tags/elements. */ + /** Tags/elements. */ pj_str_t values[PJSIP_GENERIC_ARRAY_MAX_COUNT]; } pjsip_generic_array_hdr; diff --git a/pjsip/include/pjsip/sip_resolve.h b/pjsip/include/pjsip/sip_resolve.h index b4db9b3f..089f2909 100644 --- a/pjsip/include/pjsip/sip_resolve.h +++ b/pjsip/include/pjsip/sip_resolve.h @@ -209,7 +209,7 @@ typedef void pjsip_resolver_callback(pj_status_t status, * Create SIP resolver engine. Note that this function is normally called * internally by pjsip_endpoint instance. * - * @param pf The Pool Factory. + * @param pool Pool to allocate memory from. * @param p_res Pointer to receive SIP resolver instance. * * @return PJ_SUCCESS when resolver can be successfully created. diff --git a/pjsip/include/pjsip/sip_transaction.h b/pjsip/include/pjsip/sip_transaction.h index 9550c32a..2865b6e1 100644 --- a/pjsip/include/pjsip/sip_transaction.h +++ b/pjsip/include/pjsip/sip_transaction.h @@ -360,13 +360,15 @@ PJ_DECL(pjsip_transaction*) pjsip_rdata_get_tsx( pjsip_rx_data *rdata ); */ PJ_DECL(void) pjsip_tsx_layer_dump(pj_bool_t detail); -/* +/** * Get the string name for the state. + * @param state State */ PJ_DECL(const char *) pjsip_tsx_state_str(pjsip_tsx_state_e state); -/* +/** * Get the role name. + * @param role Role. */ PJ_DECL(const char *) pjsip_role_name(pjsip_role_e role); diff --git a/pjsip/include/pjsip/sip_transport.h b/pjsip/include/pjsip/sip_transport.h index 6097abab..34ea4b21 100644 --- a/pjsip/include/pjsip/sip_transport.h +++ b/pjsip/include/pjsip/sip_transport.h @@ -919,8 +919,27 @@ PJ_DECL(pj_status_t) pjsip_tpmgr_unregister_tpfactory(pjsip_tpmgr *mgr, * TRANSPORT MANAGER * *****************************************************************************/ -typedef void (*pjsip_rx_callback)(pjsip_endpoint*, pj_status_t, pjsip_rx_data *); -typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint*, pjsip_tx_data*); + +/** + * Type of callback to be called when transport manager receives incoming + * SIP message. + * + * @param ep Endpoint. + * @param status Receiption status. + * @param rd Received packet. + */ +typedef void (*pjsip_rx_callback)(pjsip_endpoint *ep, pj_status_t status, + pjsip_rx_data *rd); + +/** + * Type of callback to be called before transport manager is about + * to transmit SIP message. + * + * @param ep Endpoint. + * @param td Transmit data. + */ +typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint *ep, pjsip_tx_data*td); + /** * Create a transport manager. Normally application doesn't need to call * this function directly, since a transport manager will be created and diff --git a/pjsip/include/pjsip/sip_util.h b/pjsip/include/pjsip/sip_util.h index 75112ccf..b6b3df8e 100644 --- a/pjsip/include/pjsip/sip_util.h +++ b/pjsip/include/pjsip/sip_util.h @@ -259,7 +259,17 @@ typedef struct pjsip_send_state } pjsip_send_state; -typedef void (*pjsip_send_callback)(pjsip_send_state*, pj_ssize_t sent, +/** + * Declaration for callback function to be specified in + * #pjsip_endpt_send_request_stateless(), #pjsip_endpt_send_response(), or + * #pjsip_endpt_send_response2(). + * + * @param st Structure to keep transmission state. + * @param sent Number of bytes sent. + * @param cont When current transmission fails, specify whether + * the function should fallback to next destination. + */ +typedef void (*pjsip_send_callback)(pjsip_send_state *st, pj_ssize_t sent, pj_bool_t *cont); /** @@ -517,7 +527,14 @@ PJ_DECL(pj_status_t) pjsip_endpt_respond( pjsip_endpoint *endpt, const pjsip_msg_body *body, pjsip_transaction **p_tsx ); -typedef void (*pjsip_endpt_send_callback)(void*, pjsip_event*); +/** + * Type of callback to be specified in #pjsip_endpt_send_request(). + * + * @param token The token that was given in #pjsip_endpt_send_request() + * @param e Completion event. + */ +typedef void (*pjsip_endpt_send_callback)(void *token, pjsip_event *e); + /** * Send outgoing request and initiate UAC transaction for the request. * This is an auxiliary function to be used by application to send arbitrary diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index d78eeb78..ca93208e 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -1104,7 +1104,7 @@ typedef struct pjsua_config PJ_DECL(void) pjsua_config_default(pjsua_config *cfg); -/* The implementation has been moved to sip_auth.h */ +/** The implementation has been moved to sip_auth.h */ #define pjsip_cred_dup pjsip_cred_info_dup @@ -1197,7 +1197,7 @@ PJ_DECL(void) pjsua_msg_data_init(pjsua_msg_data *msg_data); PJ_DECL(pj_status_t) pjsua_create(void); -/* Forward declaration */ +/** Forward declaration */ typedef struct pjsua_media_config pjsua_media_config; @@ -3393,7 +3393,7 @@ PJ_DECL(pj_status_t) pjsua_buddy_get_info(pjsua_buddy_id buddy_id, * for this buddy, this function will also start the presence subscription * session immediately. * - * @param buddy)cfg Buddy configuration. + * @param buddy_cfg Buddy configuration. * @param p_buddy_id Pointer to receive buddy ID. * * @return PJ_SUCCESS on success, or the appropriate error code. @@ -4449,7 +4449,7 @@ PJ_DECL(pjmedia_port*) pjsua_set_no_snd_dev(void); * * @param tail_ms The tail length, in miliseconds. Set to zero to * disable AEC. - * @param options Options to be passed to #pjmedia_echo_create(). + * @param options Options to be passed to pjmedia_echo_create(). * Normally the value should be zero. * * @return PJ_SUCCESS on success. |