diff options
author | Benny Prijono <bennylp@teluu.com> | 2006-06-17 04:08:30 +0000 |
---|---|---|
committer | Benny Prijono <bennylp@teluu.com> | 2006-06-17 04:08:30 +0000 |
commit | 3034f9480369cb8083cd625b358354b4618cd985 (patch) | |
tree | 93b19f8af9d64b7916825c9ee9a99dc88586cd8a /pjsip/include/pjsip/sip_event.h | |
parent | edf38f478920a443dc29cf3d638e6b27d7a838e6 (diff) |
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
Diffstat (limited to 'pjsip/include/pjsip/sip_event.h')
-rw-r--r-- | pjsip/include/pjsip/sip_event.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/pjsip/include/pjsip/sip_event.h b/pjsip/include/pjsip/sip_event.h index caac953f..5dc9d457 100644 --- a/pjsip/include/pjsip/sip_event.h +++ b/pjsip/include/pjsip/sip_event.h @@ -27,8 +27,9 @@ PJ_BEGIN_DECL /** - * @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. * @{ */ #include <pj/types.h> @@ -64,8 +65,7 @@ typedef enum pjsip_event_id_e /** - * \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 * to higher layer objects. Normally this is achieved by means of callback, @@ -85,8 +85,8 @@ struct pjsip_event */ 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. */ @@ -216,7 +216,7 @@ struct pjsip_event /** * 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); |