Changeset 2642 for pjproject/trunk/pjnath/include/pjnath/ice_session.h

Timestamp:

Apr 22, 2009 5:20:24 PM (15 years ago)

Author:

bennylp

Message:

Part of ticket #780: enhance the PJNATH doxygen documentation

File:

• pjproject/trunk/pjnath/include/pjnath/ice_session.h (modified) (5 diffs)

pjproject/trunk/pjnath/include/pjnath/ice_session.h

@@ -31 +31 @@
 #include <pj/timer.h>
 
-/**
- * @defgroup PJNATH_ICE Interactive Connectivity Establishment (ICE)
- * @brief Interactive Connectivity Establishment (ICE)
- */
-
-
 PJ_BEGIN_DECL
 
 
 /**
- * @defgroup PJNATH_ICE_SESSION ICE Session
- * @brief Transport Independent ICE Session
- * @ingroup PJNATH_ICE
+ * @addtogroup PJNATH_ICE_SESSION
  * @{
  *
@@ -205 +197 @@
 typedef struct pj_ice_msg_data
 {
+    /** Transport ID for this message */
     unsigned    transport_id;
+
+    /** Flag to indicate whether data.req contains data */
     pj_bool_t   has_req_data;
 
+    /** The data */
     union data {
+        /** Request data */
         struct request_data {
-            pj_ice_sess             *ice;
-            pj_ice_sess_checklist   *clist;
-            unsigned                 ckid;
+            pj_ice_sess             *ice;   /**< ICE session    */
+            pj_ice_sess_checklist   *clist; /**< Checklist      */
+            unsigned                 ckid;  /**< Check ID       */
         } req;
     } data;
+
 } pj_ice_msg_data;
 
@@ -540 +538 @@
 typedef struct pj_ice_rx_check
 {
-    PJ_DECL_LIST_MEMBER(struct pj_ice_rx_check);
+    PJ_DECL_LIST_MEMBER(struct pj_ice_rx_check); /**< Standard list     */
 
     unsigned             comp_id;       /**< Component ID.              */
@@ -601 +599 @@
     pj_ice_sess_cand     rcand[PJ_ICE_MAX_CAND];    /**< Array of cand.     */
 
-    /* Array of transport datas */
+    /** Array of transport datas */
     pj_ice_msg_data      tp_data[4];
 
@@ -613 +611 @@
     pj_ice_sess_checklist valid_list;               /**< Valid list.        */
     
-    /* Temporary buffer for misc stuffs to avoid using stack too much */
+    /** Temporary buffer for misc stuffs to avoid using stack too much */
     union {
         char txt[128];