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

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@515 74dad513-b988-da41-8d7b-12977e46ad98

6 files changed, 29 insertions, 3 deletions

diff --git a/pjsip/include/pjsip-simple/evsub.h b/pjsip/include/pjsip-simple/evsub.h
index 0bcd63a9..4eb2ae1c 100644
--- a/pjsip/include/pjsip-simple/evsub.h
+++ b/pjsip/include/pjsip-simple/evsub.h
@@ -30,6 +30,7 @@
 /**
  * @defgroup PJSIP_EVENT_NOT SIP Event Notification (RFC 3265) Module
  * @ingroup PJSIP_SIMPLE
+ * @brief Core Event Subscription framework, used by presence, call transfer, etc.
  * @{
  *
  * This module provides the implementation of SIP Extension for SIP Specific
@@ -430,7 +431,7 @@ PJ_DECL(pjsip_evsub*) pjsip_tsx_get_evsub(pjsip_transaction *tsx);
  * Set event subscription's module data.
  *
  * @param sub		The event subscription.
- * @param index		The module id.
+ * @param mod_id	The module id.
  * @param data		Arbitrary data.
  */
 PJ_DECL(void) pjsip_evsub_set_mod_data( pjsip_evsub *sub, unsigned mod_id,
diff --git a/pjsip/include/pjsip-simple/evsub_msg.h b/pjsip/include/pjsip-simple/evsub_msg.h
index 4f4a9b92..3f464ddb 100644
--- a/pjsip/include/pjsip-simple/evsub_msg.h
+++ b/pjsip/include/pjsip-simple/evsub_msg.h
@@ -26,6 +26,7 @@
 #include <pjsip/sip_msg.h>
 
 /**
+ * @defgroup PJSIP_EVENT_HDRS Additional Header Fields
  * @ingroup PJSIP_EVENT_NOT
  * @{
  */
@@ -41,7 +42,9 @@ PJ_BEGIN_DECL
  */
 typedef struct pjsip_event_hdr
 {
+    /** Standard header fields. */
     PJSIP_DECL_HDR_MEMBER(struct pjsip_event_hdr);
+
     pj_str_t	    event_type;	    /**< Event name. */
     pj_str_t	    id_param;	    /**< Optional event ID parameter. */
     pjsip_param	    other_param;    /**< Other parameter. */
@@ -66,11 +69,12 @@ typedef pjsip_generic_array_hdr pjsip_allow_events_hdr;
 /**
  * Create a new Allow-Events header.
  *
- * @param pool.	    The pool.
+ * @param pool	    The pool.
  *
  * @return	    Allow-Events header.
  */
-PJ_DECL(pjsip_allow_events_hdr*) pjsip_allow_events_hdr_create(pj_pool_t *pool);
+PJ_DECL(pjsip_allow_events_hdr*) 
+pjsip_allow_events_hdr_create(pj_pool_t *pool);
 
 
 /**
@@ -78,7 +82,9 @@ PJ_DECL(pjsip_allow_events_hdr*) pjsip_allow_events_hdr_create(pj_pool_t *pool);
  */
 typedef struct pjsip_sub_state_hdr
 {
+    /** Standard header fields. */
     PJSIP_DECL_HDR_MEMBER(struct pjsip_sub_state_hdr);
+
     pj_str_t	    sub_state;		/**< Subscription state. */
     pj_str_t	    reason_param;	/**< Optional termination reason. */
     int		    expires_param;	/**< Expires param, or -1. */
diff --git a/pjsip/include/pjsip-simple/iscomposing.h b/pjsip/include/pjsip-simple/iscomposing.h
index b5544ea4..428c1251 100644
--- a/pjsip/include/pjsip-simple/iscomposing.h
+++ b/pjsip/include/pjsip-simple/iscomposing.h
@@ -26,6 +26,15 @@
 #include <pjsip-simple/types.h>
 #include <pjlib-util/xml.h>
 
+/**
+ * @defgroup PJSIP_ISCOMPOSING Message Composition Indication (RFC 3994)
+ * @ingroup PJSIP_SIMPLE
+ * @brief Support for Indication of Message Composition (RFC 3994)
+ * @{
+ *
+ * This implements message composition indication, as described in
+ * RFC 3994.
+ */
 
 PJ_BEGIN_DECL
 
@@ -113,6 +122,10 @@ PJ_DECL(pj_status_t) pjsip_iscomposing_parse( pj_pool_t *pool,
 					      int *p_refresh );
 
 
+/**
+ * @}
+ */
+
 
 PJ_END_DECL
 
diff --git a/pjsip/include/pjsip-simple/pidf.h b/pjsip/include/pjsip-simple/pidf.h
index 1b57c5d2..ccd844ce 100644
--- a/pjsip/include/pjsip-simple/pidf.h
+++ b/pjsip/include/pjsip-simple/pidf.h
@@ -32,6 +32,7 @@ PJ_BEGIN_DECL
 /**
  * @defgroup PJSIP_SIMPLE_PIDF PIDF/Presence Information Data Format (RFC 3863)
  * @ingroup PJSIP_SIMPLE
+ * @brief Support for PIDF/Presence Information Data Format (RFC 3863)
  * @{
  *
  * This file provides tools for manipulating Presence Information Data 
diff --git a/pjsip/include/pjsip-simple/presence.h b/pjsip/include/pjsip-simple/presence.h
index f8d63527..ee2805f4 100644
--- a/pjsip/include/pjsip-simple/presence.h
+++ b/pjsip/include/pjsip-simple/presence.h
@@ -34,6 +34,7 @@ PJ_BEGIN_DECL
 /**
  * @defgroup PJSIP_SIMPLE_PRES SIP Extension for Presence (RFC 3856)
  * @ingroup PJSIP_SIMPLE
+ * @brief Support for SIP Extension for Presence (RFC 3856)
  * @{
  *
  * This module contains the implementation of SIP Presence Extension as 
@@ -67,6 +68,9 @@ PJ_DECL(pj_status_t) pjsip_pres_init_module(pjsip_endpoint *endpt,
 PJ_DECL(pjsip_module*) pjsip_pres_instance(void);
 
 
+/**
+ * Maximum presence status info.
+ */
 #define PJSIP_PRES_STATUS_MAX_INFO  8
 
 /**
diff --git a/pjsip/include/pjsip-simple/xpidf.h b/pjsip/include/pjsip-simple/xpidf.h
index c5736c54..17938fd6 100644
--- a/pjsip/include/pjsip-simple/xpidf.h
+++ b/pjsip/include/pjsip-simple/xpidf.h
@@ -31,6 +31,7 @@ PJ_BEGIN_DECL
 /**
  * @defgroup PJSIP_SIMPLE_XPIDF XPIDF/Presence Information Data Format
  * @ingroup PJSIP_SIMPLE
+ * @brief Support for XPIDF/Presence Information Data Format
  * @{
  *
  * This is an old presence data format as described in: