Browse code

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

Henning Westerholt authored on 08/08/2011 20:18:28
Showing 14 changed files
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: presence.c 1953 2007-04-04 08:50:33Z anca_vamanu $
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,9 +22,9 @@
26 26
  *  2007-04-04  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
30
- * \brief Kamailio presence module
31
- * \ref event_list.h
29
+/*!
30
+ * \file
31
+ * \brief Kamailio presence module :: Events
32 32
  * \ingroup presence 
33 33
  */
34 34
 
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: event_list.h 1953 2007-04-04 08:50:33Z anca_vamanu $
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,7 +22,8 @@
26 26
  *  2007-04-05  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio presence module :: Events
31 32
  * \ingroup presence 
32 33
  */
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,18 +22,18 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
-/*! \defgroup presence Presence :: A generic implementation of the SIP event package (PUBLISH, SUBSCRIBE, NOTIFY)
30
- *
31
- *	   The Kamailio presence module is a generic module for SIP event packages, which is much more than presence.
32
- *	   It is extensible by developing other modules that use the internal developer API.
33
- *	   Examples:
34
- *	   - \ref presence_mwi
35
- *	   - \ref presence_xml
29
+/*!
30
+ * \defgroup presence Presence :: A generic implementation of the SIP event package (PUBLISH, SUBSCRIBE, NOTIFY)
31
+ * The Kamailio presence module is a generic module for SIP event packages, which is much more than presence.
32
+ * It is extensible by developing other modules that use the internal developer API.
33
+ * Examples:
34
+ *- \ref presence_mwi
35
+ *- \ref presence_xml
36 36
  */
37 37
 
38
-/*! \file
39
- * \brief Kamailio presence module
40
- * 
38
+/*!
39
+ * \file
40
+ * \brief Kamailio presence module :: Core
41 41
  * \ingroup presence 
42 42
  */
43 43
 
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id
3
- *
4
- * presence - presence server implementation
5
- * 
6 2
  * Copyright (C) 2006 Voice Sistem SRL
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -27,7 +23,8 @@
27 27
  *  2006-10-09  first version (anca)
28 28
  */
29 29
 
30
-/*! \file
30
+/*!
31
+ * \file
31 32
  * \brief Kamailio presence module :: Core
32 33
  * \ingroup presence 
33 34
  */
... ...
@@ -46,14 +43,14 @@
46 46
 
47 47
 /* DB modes */
48 48
 
49
-/* subscriptions are held in memory and periodically updated to db, but retrieved from db only at startup */
49
+/** subscriptions are held in memory and periodically updated to db, but retrieved from db only at startup */
50 50
 #define DB_MEMORY_ONLY 0
51
-/* same as memory_only, but if a subscription is not found, it falls back to db */
51
+/** same as memory_only, but if a subscription is not found, it falls back to db */
52 52
 #define DB_FALLBACK 1
53
-/* subscriptions are held only in database */
53
+/** subscriptions are held only in database */
54 54
 #define DB_ONLY 2
55 55
 
56
-/* TM bind */
56
+/** TM bind */
57 57
 extern struct tm_binds tmb;
58 58
 
59 59
 extern sl_api_t slb;
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,7 +22,8 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio presence module :: Presentity handling
31 32
  * \ingroup presence 
32 33
  */
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,9 +22,9 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio presence module :: Presentity handling
31
- * \ref presentity.c
32 32
  * \ingroup presence 
33 33
  */
34 34
 
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,7 +22,8 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio presence module :: Support for PUBLISH handling
31 32
  * \ingroup presence 
32 33
  */
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4
- * presence module - presence server implementation
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,9 +22,9 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio presence module :: PUBLISH support
31
- * \ref publish.c
32 32
  * \ingroup presence 
33 33
  */
34 34
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * presence_mwi module - Presence Handling of message-summary events
3
- *
4 2
  * Copyright (C) 2007 Juha Heinanen
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -24,6 +22,11 @@
24 24
  *  2007-05-1  initial version (jih)
25 25
  */
26 26
 
27
+
28
+/*!
29
+ * \defgroup presence_mwi Presence_mwi :: Presence Handling of message-summary events
30
+ */
31
+
27 32
 /*!
28 33
  * \file
29 34
  * \brief SIP-router Presence :: Message waiting indication
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * presence_mwi module - presence_mwi header file
3
- *
4 2
  * Copyright (C) 2007 Juha Heinanen
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: add_events.c 2006-12-07 18:05:05Z anca_vamanu $
3
- *
4
- * presence_xml module - 
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,14 +22,13 @@
26 26
  *  2007-04-17  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
30
- * \brief Kamailio Presence_XML :: 
29
+/*!
30
+ * \file
31
+ * \brief Kamailio Presence_XML :: Several event packages, presence, presence.winfo, dialog;sla 
31 32
  * \ingroup presence_xml
32 33
  */
33 34
 
34
-/*
35
- *	add 3 events: presence, presence.winfo, dialog;sla
36
- * */
35
+
37 36
 #include <stdio.h>
38 37
 #include <stdlib.h>
39 38
 #include <string.h>
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: add_events.h 2006-12-07 18:05:05Z anca_vamanu $
3
- *
4
- * presence_xml module - 
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,9 +22,9 @@
26 26
  *  2007-04-18  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
30
- * \brief Kamailio Presence_XML :: 
31
- * \ref add_events.c
29
+/*!
30
+ * \file
31
+ * \brief Kamailio Presence_XML :: Several event packages, presence, presence.winfo, dialog;sla 
32 32
  * \ingroup presence_xml
33 33
  */
34 34
 
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: presence_xml.c 2006-12-07 18:05:05Z anca_vamanu$
3
- *
4
- * presence_xml module - Presence Handling XML bodies module
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -26,12 +22,14 @@
26 26
  *  2007-04-12  initial version (anca)
27 27
  */
28 28
 
29
-/*! \file
29
+/*!
30
+ * \file
30 31
  * \brief Kamailio Presence_XML :: Core
31 32
  * \ingroup presence_xml
32 33
  */
33 34
 
34
-/*! \defgroup presence_xml Presence_xml :: This module implements a range of XML-based SIP event packages for presence
35
+/*!
36
+ * \defgroup presence_xml Presence_xml :: This module implements a range of XML-based SIP event packages for presence
35 37
  */
36 38
 
37 39
 
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- * $Id: presence_xml.h 2006-12-07 18:05:05Z anca_vamanu$
3
- *
4
- * presence_xml module - Presence Handling XML bodies module
5
- *
6 2
  * Copyright (C) 2006 Voice Sistem S.R.L.
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.