[sr-dev] git:master: presence(k): fix doxygen errors, small extensions and cleanups in comments

Module: sip-router Branch: master Commit: 20ba5af96cc874cee9c68c2781cd46d0f0c1e3fb URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=20ba5af… Author: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Committer: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Date: Mon Aug 8 22:18:28 2011 +0200 presence(k): fix doxygen errors, small extensions and cleanups in comments --- modules_k/presence/event_list.c | 10 +++------- modules_k/presence/event_list.h | 7 ++----- modules_k/presence/presence.c | 24 ++++++++++-------------- modules_k/presence/presence.h | 15 ++++++--------- modules_k/presence/presentity.c | 7 ++----- modules_k/presence/presentity.h | 8 ++------ modules_k/presence/publish.c | 7 ++----- modules_k/presence/publish.h | 8 ++------ modules_k/presence_mwi/presence_mwi.c | 7 +++++-- modules_k/presence_mwi/presence_mwi.h | 2 -- modules_k/presence_xml/add_events.c | 13 ++++--------- modules_k/presence_xml/add_events.h | 10 +++------- modules_k/presence_xml/presence_xml.c | 10 ++++------ modules_k/presence_xml/presence_xml.h | 4 ---- 14 files changed, 45 insertions(+), 87 deletions(-) diff --git a/modules_k/presence/event_list.c b/modules_k/presence/event_list.c index a8d3eac..0d628b6 100644 --- a/modules_k/presence/event_list.c +++ b/modules_k/presence/event_list.c @@ -1,8 +1,4 @@ /* - * $Id: presence.c 1953 2007-04-04 08:50:33Z anca_vamanu $ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,9 +22,9 @@ * 2007-04-04 initial version (anca) */ -/*! \file - * \brief Kamailio presence module - * \ref event_list.h +/*! + * \file + * \brief Kamailio presence module :: Events * \ingroup presence */ diff --git a/modules_k/presence/event_list.h b/modules_k/presence/event_list.h index 5082a73..23fdeba 100644 --- a/modules_k/presence/event_list.h +++ b/modules_k/presence/event_list.h @@ -1,8 +1,4 @@ /* - * $Id: event_list.h 1953 2007-04-04 08:50:33Z anca_vamanu $ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,7 +22,8 @@ * 2007-04-05 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: Events * \ingroup presence */ diff --git a/modules_k/presence/presence.c b/modules_k/presence/presence.c index e97df6c..d211b53 100644 --- a/modules_k/presence/presence.c +++ b/modules_k/presence/presence.c @@ -1,8 +1,4 @@ /* - * $Id$ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,18 +22,18 @@ * 2006-08-15 initial version (anca) */ -/*! \defgroup presence Presence :: A generic implementation of the SIP event package (PUBLISH, SUBSCRIBE, NOTIFY) - * - * The Kamailio presence module is a generic module for SIP event packages, which is much more than presence. - * It is extensible by developing other modules that use the internal developer API. - * Examples: - * - \ref presence_mwi - * - \ref presence_xml +/*! + * \defgroup presence Presence :: A generic implementation of the SIP event package (PUBLISH, SUBSCRIBE, NOTIFY) + * The Kamailio presence module is a generic module for SIP event packages, which is much more than presence. + * It is extensible by developing other modules that use the internal developer API. + * Examples: + *- \ref presence_mwi + *- \ref presence_xml */ -/*! \file - * \brief Kamailio presence module - * +/*! + * \file + * \brief Kamailio presence module :: Core * \ingroup presence */ diff --git a/modules_k/presence/presence.h b/modules_k/presence/presence.h index 7fb3271..88520f3 100644 --- a/modules_k/presence/presence.h +++ b/modules_k/presence/presence.h @@ -1,8 +1,4 @@ /* - * $Id - * - * presence - presence server implementation - * * Copyright (C) 2006 Voice Sistem SRL * * This file is part of Kamailio, a free SIP server. @@ -27,7 +23,8 @@ * 2006-10-09 first version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: Core * \ingroup presence */ @@ -46,14 +43,14 @@ /* DB modes */ -/* subscriptions are held in memory and periodically updated to db, but retrieved from db only at startup */ +/** subscriptions are held in memory and periodically updated to db, but retrieved from db only at startup */ #define DB_MEMORY_ONLY 0 -/* same as memory_only, but if a subscription is not found, it falls back to db */ +/** same as memory_only, but if a subscription is not found, it falls back to db */ #define DB_FALLBACK 1 -/* subscriptions are held only in database */ +/** subscriptions are held only in database */ #define DB_ONLY 2 -/* TM bind */ +/** TM bind */ extern struct tm_binds tmb; extern sl_api_t slb; diff --git a/modules_k/presence/presentity.c b/modules_k/presence/presentity.c index 871850b..427a572 100644 --- a/modules_k/presence/presentity.c +++ b/modules_k/presence/presentity.c @@ -1,8 +1,4 @@ /* - * $Id$ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,7 +22,8 @@ * 2006-08-15 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: Presentity handling * \ingroup presence */ diff --git a/modules_k/presence/presentity.h b/modules_k/presence/presentity.h index 7253f83..2d5e9e5 100644 --- a/modules_k/presence/presentity.h +++ b/modules_k/presence/presentity.h @@ -1,8 +1,4 @@ /* - * $Id$ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,9 +22,9 @@ * 2006-08-15 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: Presentity handling - * \ref presentity.c * \ingroup presence */ diff --git a/modules_k/presence/publish.c b/modules_k/presence/publish.c index 839ed01..c2738bb 100644 --- a/modules_k/presence/publish.c +++ b/modules_k/presence/publish.c @@ -1,8 +1,4 @@ /* - * $Id$ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,7 +22,8 @@ * 2006-08-15 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: Support for PUBLISH handling * \ingroup presence */ diff --git a/modules_k/presence/publish.h b/modules_k/presence/publish.h index 95bdf84..5960e24 100644 --- a/modules_k/presence/publish.h +++ b/modules_k/presence/publish.h @@ -1,8 +1,4 @@ /* - * $Id$ - * - * presence module - presence server implementation - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,9 +22,9 @@ * 2006-08-15 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio presence module :: PUBLISH support - * \ref publish.c * \ingroup presence */ diff --git a/modules_k/presence_mwi/presence_mwi.c b/modules_k/presence_mwi/presence_mwi.c index fc03c7f..1b2e8f3 100644 --- a/modules_k/presence_mwi/presence_mwi.c +++ b/modules_k/presence_mwi/presence_mwi.c @@ -1,6 +1,4 @@ /* - * presence_mwi module - Presence Handling of message-summary events - * * Copyright (C) 2007 Juha Heinanen * * This file is part of Kamailio, a free SIP server. @@ -24,6 +22,11 @@ * 2007-05-1 initial version (jih) */ + +/*! + * \defgroup presence_mwi Presence_mwi :: Presence Handling of message-summary events + */ + /*! * \file * \brief SIP-router Presence :: Message waiting indication diff --git a/modules_k/presence_mwi/presence_mwi.h b/modules_k/presence_mwi/presence_mwi.h index f77ab8b..6767dd1 100644 --- a/modules_k/presence_mwi/presence_mwi.h +++ b/modules_k/presence_mwi/presence_mwi.h @@ -1,6 +1,4 @@ /* - * presence_mwi module - presence_mwi header file - * * Copyright (C) 2007 Juha Heinanen * * This file is part of Kamailio, a free SIP server. diff --git a/modules_k/presence_xml/add_events.c b/modules_k/presence_xml/add_events.c index 21317cd..347cf24 100644 --- a/modules_k/presence_xml/add_events.c +++ b/modules_k/presence_xml/add_events.c @@ -1,8 +1,4 @@ /* - * $Id: add_events.c 2006-12-07 18:05:05Z anca_vamanu $ - * - * presence_xml module - - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,14 +22,13 @@ * 2007-04-17 initial version (anca) */ -/*! \file - * \brief Kamailio Presence_XML :: +/*! + * \file + * \brief Kamailio Presence_XML :: Several event packages, presence, presence.winfo, dialog;sla * \ingroup presence_xml */ -/* - * add 3 events: presence, presence.winfo, dialog;sla - * */ + #include <stdio.h> #include <stdlib.h> #include <string.h> diff --git a/modules_k/presence_xml/add_events.h b/modules_k/presence_xml/add_events.h index 4bce3af..3108302 100644 --- a/modules_k/presence_xml/add_events.h +++ b/modules_k/presence_xml/add_events.h @@ -1,8 +1,4 @@ /* - * $Id: add_events.h 2006-12-07 18:05:05Z anca_vamanu $ - * - * presence_xml module - - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,9 +22,9 @@ * 2007-04-18 initial version (anca) */ -/*! \file - * \brief Kamailio Presence_XML :: - * \ref add_events.c +/*! + * \file + * \brief Kamailio Presence_XML :: Several event packages, presence, presence.winfo, dialog;sla * \ingroup presence_xml */ diff --git a/modules_k/presence_xml/presence_xml.c b/modules_k/presence_xml/presence_xml.c index e3bb8f2..2ab267b 100644 --- a/modules_k/presence_xml/presence_xml.c +++ b/modules_k/presence_xml/presence_xml.c @@ -1,8 +1,4 @@ /* - * $Id: presence_xml.c 2006-12-07 18:05:05Z anca_vamanu$ - * - * presence_xml module - Presence Handling XML bodies module - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server. @@ -26,12 +22,14 @@ * 2007-04-12 initial version (anca) */ -/*! \file +/*! + * \file * \brief Kamailio Presence_XML :: Core * \ingroup presence_xml */ -/*! \defgroup presence_xml Presence_xml :: This module implements a range of XML-based SIP event packages for presence +/*! + * \defgroup presence_xml Presence_xml :: This module implements a range of XML-based SIP event packages for presence */ diff --git a/modules_k/presence_xml/presence_xml.h b/modules_k/presence_xml/presence_xml.h index 4f0d007..8678bc3 100644 --- a/modules_k/presence_xml/presence_xml.h +++ b/modules_k/presence_xml/presence_xml.h @@ -1,8 +1,4 @@ /* - * $Id: presence_xml.h 2006-12-07 18:05:05Z anca_vamanu$ - * - * presence_xml module - Presence Handling XML bodies module - * * Copyright (C) 2006 Voice Sistem S.R.L. * * This file is part of Kamailio, a free SIP server.