Browse Source

presence(k): fix doxygen errors, small extensions and cleanups in comments

Henning Westerholt 14 years ago
parent
commit
20ba5af96c

+ 3 - 7
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 
  */
 

+ 2 - 5
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 
  */

+ 10 - 14
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 
  */
 

+ 6 - 9
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;

+ 2 - 5
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 
  */

+ 2 - 6
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 
  */
 

+ 2 - 5
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 
  */

+ 2 - 6
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 
  */
 

+ 5 - 2
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

+ 0 - 2
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.

+ 4 - 9
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>

+ 3 - 7
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
  */
 

+ 4 - 6
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
  */
 
 

+ 0 - 4
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.