Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_ua_layer.h

Timestamp:

Jun 17, 2006 4:08:30 AM (18 years ago)

Author:

bennylp

Message:

Modifications all over the place, but mainly only to update Doxygen documentation

File:

• pjproject/trunk/pjsip/include/pjsip/sip_ua_layer.h (modified) (4 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_ua_layer.h

@@ -30 +30 @@
 
 /**
- * @defgroup PJSUA SIP User Agent Stack
+ * @defgroup PJSIP_UA Base User Agent Layer/Common Dialog Layer
+ * @ingroup PJSIP
+ * @brief Dialog management.
+ *
+ * This module provides basic dialog management, which is used by higher
+ * layer dialog usages such as INVITE sessions and SIP Event Subscription
+ * framework (RFC 3265). Application should link  with <b>pjsip-core</b> 
+ * library to use this base UA layer. The base UA layer module is initialized
+ * with #pjsip_ua_init_module().
  */
 
 /**
  * @defgroup PJSUA_UA SIP User Agent Module
- * @ingroup PJSUA
+ * @ingroup PJSIP_UA
+ * @brief Provides dialog management.
  * @{
- * \brief
- *   User Agent manages the interactions between application and SIP dialogs.
+ *
+ * Application MUST initialize the user agent layer module by calling
+ * #pjsip_ua_init_module() before using any of the dialog API, and link
+ * the application with with <b>pjsip-core</b> library.
  */
 
@@ -44 +55 @@
 typedef struct pjsip_ua_init_param
 {
+    /** Callback to be called when the UA layer detects that outgoing
+     *  dialog has forked.
+     */
     pjsip_dialog* (*on_dlg_forked)(pjsip_dialog *first_set, pjsip_rx_data *res);
 } pjsip_ua_init_param;
@@ -91 +105 @@
 
 
+/**
+ * @}
+ */
+
+
 /*
  * Internal (called by sip_dialog.c).
@@ -101 +120 @@
 
 
-/**
- * @}
- */
-
 PJ_END_DECL