Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_event.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_event.h (modified) (4 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_event.h

@@ -28 +28 @@
 
 /**
- * @defgroup PJSIP_EVENT SIP Event
- * @ingroup PJSIP
+ * @defgroup PJSIP_EVENT Event
+ * @ingroup PJSIP_CORE_CORE
+ * @brief Representation of events as they are distributed among modules.
  * @{
  */
@@ -65 +66 @@
 
 /**
- * \struct
- * \brief Event descriptor to fully identify a SIP event.
+ * This structure describe event descriptor to fully identify a SIP event.
  *
  * Events are the only way for a lower layer object to inform something
@@ -86 +86 @@
     pjsip_event_id_e type;
 
-    /*
-     * The event body.
+    /**
+     * The event body as union, which fields depends on the event type.
      * By convention, the first member of each struct in the union must be
      * the pointer which is relevant to the event.
@@ -217 +217 @@
  * Get the event string from the event ID.
  * @param e the event ID.
- * @notes defined in sip_util.c
+ * @note defined in sip_util.c
  */
 PJ_DEF(const char *) pjsip_event_str(pjsip_event_id_e e);