summaryrefslogtreecommitdiff
path: root/pjsip/include
diff options
context:
space:
mode:
authorBenny Prijono <bennylp@teluu.com>2006-09-22 20:43:00 +0000
committerBenny Prijono <bennylp@teluu.com>2006-09-22 20:43:00 +0000
commit6ff54be10fd9c0ceff14e10f83a1d1af82ede83f (patch)
treea5d47b8ba6a1490ea5d60ea73b85a75a7926e43a /pjsip/include
parent0228f9f0db50b781d00dc3f5936b4a99504fddc7 (diff)
Updated doxygen documentation for the website
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@736 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjsip/include')
-rw-r--r--pjsip/include/pjsip/sip_endpoint.h11
-rw-r--r--pjsip/include/pjsip/sip_msg.h2
-rw-r--r--pjsip/include/pjsip/sip_transport.h2
-rw-r--r--pjsip/include/pjsip/sip_util.h2
4 files changed, 6 insertions, 11 deletions
diff --git a/pjsip/include/pjsip/sip_endpoint.h b/pjsip/include/pjsip/sip_endpoint.h
index e6632042..aed4d8a2 100644
--- a/pjsip/include/pjsip/sip_endpoint.h
+++ b/pjsip/include/pjsip/sip_endpoint.h
@@ -244,9 +244,7 @@ PJ_DECL(pjsip_transaction*) pjsip_endpt_find_tsx( pjsip_endpoint *endpt,
/**
* Register the transaction to the endpoint's transaction table.
- * Before the transaction is registered, it must have been initialized as
- * either UAS or UAC by calling #pjsip_tsx_init_uac or #pjsip_tsx_init_uas.
- * This function, like all other endpoint functions, is thread safe.
+ * This function should only be used internally by the stack.
*
* @param endpt The SIP endpoint.
* @param tsx The transaction.
@@ -255,11 +253,8 @@ PJ_DECL(void) pjsip_endpt_register_tsx( pjsip_endpoint *endpt,
pjsip_transaction *tsx);
/**
- * Forcefull destroy the transaction.
- * The only time where application needs to call this function is when the
- * transaction fails to initialize in #pjsip_tsx_init_uac or
- * #pjsip_tsx_init_uas. For other cases. the transaction will be destroyed
- * automaticly by endpoint.
+ * Forcefull destroy the transaction. This function should only be used
+ * internally by the stack.
*
* @param endpt The endpoint.
* @param tsx The transaction to destroy.
diff --git a/pjsip/include/pjsip/sip_msg.h b/pjsip/include/pjsip/sip_msg.h
index 08f8e88e..b27b2708 100644
--- a/pjsip/include/pjsip/sip_msg.h
+++ b/pjsip/include/pjsip/sip_msg.h
@@ -910,7 +910,7 @@ pjsip_generic_string_hdr_init( pj_pool_t *pool,
* very short (for example, creating the header in the stack to be passed
* as argument to a function which will copy the header).
*
- * @param pool The pool.
+ * @param h The header to be initialized.
* @param hname The header name to be assigned to the header, or NULL to
* assign the header name with some string.
* @param hvalue Optional string to be assigned as the value.
diff --git a/pjsip/include/pjsip/sip_transport.h b/pjsip/include/pjsip/sip_transport.h
index ec371f0f..f0f915cd 100644
--- a/pjsip/include/pjsip/sip_transport.h
+++ b/pjsip/include/pjsip/sip_transport.h
@@ -360,7 +360,7 @@ typedef struct pjsip_tx_data_op_key
* this buffer will be destroyed.
*
* A transaction object normally will add reference counter to this buffer
- * when application calls #pjsip_tsx_on_tx_msg, because it needs to keep the
+ * when application calls #pjsip_tsx_send_msg, because it needs to keep the
* message for retransmission. The transaction will release the reference
* counter once its state has reached final state.
*/
diff --git a/pjsip/include/pjsip/sip_util.h b/pjsip/include/pjsip/sip_util.h
index d2b46be1..2b77e469 100644
--- a/pjsip/include/pjsip/sip_util.h
+++ b/pjsip/include/pjsip/sip_util.h
@@ -395,7 +395,7 @@ PJ_DECL(pj_status_t) pjsip_endpt_respond( pjsip_endpoint *endpt,
* Send outgoing request and initiate UAC transaction for the request.
* This is an auxiliary function to be used by application to send arbitrary
* requests outside a dialog. To send a request within a dialog, application
- * should use #pjsip_dlg_send_msg instead.
+ * should use #pjsip_dlg_send_request instead.
*
* @param endpt The endpoint instance.
* @param tdata The transmit data to be sent.