Commit 90ae1bc7 authored by Pekka Pessi's avatar Pekka Pessi

nua module: updated doxygen documentation.

darcs-hash:20060906065148-65a35-9477c42ba148819a7a7306736050957c459f0593.gz
parent 5f77870e
......@@ -15,6 +15,8 @@ TAGFILES += ../docs/doxytags_sip=../sip
TAGFILES += ../docs/doxytags_sresolv=../sresolv
TAGFILES += ../docs/doxytags_tport=../tport
TAGFILES += ../docs/doxytags_nta=../nta
TAGFILES += ../docs/doxytags_soa=../soa
TAGFILES += ../docs/doxytags_nea=../nea
TAGFILES += ../docs/doxytags_sdp=../sdp
GENERATE_TAGFILE = ../docs/doxytags_nua
......
......@@ -460,7 +460,8 @@ int nua_handle_has_active_call(nua_handle_t const *nh)
*
* @retval 0 if no call on hold in operation or operation handle is invalid
* @retval 1 if operation has call on hold, for example nua_invite() or
* nua_update() has been called with NUTAG_HOLD() with != 0 argument.
* nua_update() has been called with SOATAG_HOLD() with non-NULL
* argument.
*
* @par Related tags:
* none
......@@ -1003,8 +1004,8 @@ void nua_prack(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
*
* @par Events:
* #nua_r_update \n
* #nua_i_state \n
* #nua_i_media_error \n
* #nua_i_media_update
*/
void nua_update(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
{
......@@ -1069,10 +1070,8 @@ void nua_redirect(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
}
/** Respond with given status.
*
* The INVITE requests should be responded with
* #nua_intive_respond() function because there
* might be another request going on besides INVITE.
*
* Currently, only requests application is let to respond is INVITE.
*
* @param nh Pointer to operation handle
* @param status SIP response status (see RFCs of SIP)
......
......@@ -2099,14 +2099,15 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
*
* Media error indication.
*
* This may be sent after an implicit
* media operation has failed while processing incoming or outgoing call.
* This may be sent after an SOA
* operation has failed while processing incoming or outgoing call.
* Currently, it is not used.
*
* @param nh operation handle associated with the call
* @param hmagic operation magic associated with this call
* (maybe NULL if call handle was created for this call)
* @param sip NULL
* @param tags #NUTAG_MEDIA_SESSION (optionally)
* @param tags empty
*/
/** @var nua_event_e::nua_i_message
......@@ -2133,6 +2134,17 @@ NUTAG_AUTOANSWER(0) on B side, NUTAG_AUTOACK(0) on A side.
* @param tags empty
*/
/** @var nua_event_e::nua_i_network_changed
*
* Local IP(v6) address has changed.
*
* @param nh default operation handle
* @param hmagic operation magic associated with the default operation handle
* @param sip NULL
* @param tags empty
*
*/
/** @var nua_event_e::nua_i_notify
*
* Incoming event.
......
......@@ -763,7 +763,7 @@ int nua_stack_set_smime_params(nua_t *nua, tagi_t const *tags)
* othervise same tags as nua_set_hparams()
*
* @par Events:
* #nua_r_get_hparams
* #nua_r_get_params
*/
/**@internal
......
......@@ -145,7 +145,7 @@ typedef enum nua_event_e {
/* NOTE: Post 1.12 release events come here (below) to keep ABI
compatibility! */
nua_i_network_changed, /**< Our IP(v6) address has changed */
nua_i_network_changed, /**< Local IP(v6) address has changed */
} nua_event_t;
......
......@@ -353,7 +353,10 @@ SOFIAPUBVAR tag_typedef_t nutag_min_se;
SOFIAPUBVAR tag_typedef_t nutag_min_se_ref;
enum nua_session_refresher {
nua_no_refresher, nua_local_refresher, nua_remote_refresher, nua_any_refresher
nua_no_refresher, /**< Disable session timer. */
nua_local_refresher, /**< Session refresh by local end. */
nua_remote_refresher, /**< Session refresh by remote end. */
nua_any_refresher /**< No preference (default). */
};
/** Specify preferred refresher.
......@@ -1570,7 +1573,7 @@ SOFIAPUBVAR tag_typedef_t nutag_answer_sent_ref;
/** Enable detection of local IP address updates
*
* @par Used with
* #nua_i_network_updated
* #nua_i_network_changed
*
* @par Parameter type
* int
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment