Browse code

- doxygen and formatting changes - patch provided from Olle E. Johansson, closes #2024590

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4499 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 23/07/2008 16:12:45
Showing 10 changed files
... ...
@@ -26,6 +26,11 @@
26 26
  *  2007-04-17  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: 
31
+ * \ingroup presence_xml
32
+ */
33
+
29 34
 /*
30 35
  *	add 3 events: presence, presence.winfo, dialog;sla
31 36
  * */
... ...
@@ -26,6 +26,13 @@
26 26
  *  2007-04-18  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: 
31
+ * \ref add_events.c
32
+ * \ingroup presence_xml
33
+ */
34
+
35
+
29 36
 #ifndef _XML_ADD_EV_H_
30 37
 #define _XML_ADD_EV_H_
31 38
 
... ...
@@ -25,6 +25,11 @@
25 25
  * --------
26 26
  *  2007-04-11  initial version (anca)
27 27
  */
28
+/*! \file
29
+ * \brief OpenSER Presence_XML :: Notify BODY handling
30
+ * \ingroup presence_xml
31
+ */
32
+
28 33
 
29 34
 #include <string.h>
30 35
 #include <stdlib.h>
... ...
@@ -26,6 +26,13 @@
26 26
  *  2007-04-11  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: 
31
+ * \ref notify_body.c
32
+ * \ingroup presence_xml
33
+ */
34
+
35
+
29 36
 #ifndef _NBODY_H_
30 37
 #define _NBODY_H_
31 38
 
... ...
@@ -25,6 +25,12 @@
25 25
  * --------
26 26
  *  2007-04-14  initial version (anca)
27 27
  */
28
+
29
+/*! \file
30
+ * \brief OpenSER Presence_XML ::  PIDF handling
31
+ * \ingroup presence_xml
32
+ */
33
+
28 34
 #define _XOPEN_SOURCE
29 35
 
30 36
 #include <time.h>
... ...
@@ -26,6 +26,13 @@
26 26
  *  2006-08-15  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: PIDF handling
31
+ * \ref pidf.c
32
+ * \ingroup presence_xml
33
+ */
34
+
35
+
29 36
 #ifndef PIDF_H
30 37
 #define PIDF_H
31 38
 
... ...
@@ -26,6 +26,16 @@
26 26
  *  2007-04-12  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: Core
31
+ * \ingroup presence_xml
32
+ */
33
+
34
+/*! \defgroup presence_xml
35
+ * This module implements a range of XML-based SIP event packages for presence
36
+ */
37
+
38
+
29 39
 #include <stdio.h>
30 40
 #include <stdlib.h>
31 41
 #include <string.h>
... ...
@@ -88,13 +98,13 @@ db_func_t pxml_dbf;
88 98
 xcapGetNewDoc_t xcap_GetNewDoc;
89 99
 
90 100
 static param_export_t params[]={
91
-	{ "db_url",					STR_PARAM,                          &db_url.s},
92
-	{ "xcap_table",				STR_PARAM,                      &xcap_table.s},
93
-	{ "force_active",			INT_PARAM,                     &force_active },
94
-	{ "pidf_manipulation",      INT_PARAM,                 &pidf_manipulation}, 
95
-	{ "integrated_xcap_server", INT_PARAM,            &integrated_xcap_server}, 
96
-	{ "xcap_server",     STR_PARAM|USE_FUNC_PARAM,(void*)pxml_add_xcap_server},
97
-	{  0,						0,										    0}
101
+	{ "db_url",		STR_PARAM, &db_url.s},
102
+	{ "xcap_table",		STR_PARAM, &xcap_table.s},
103
+	{ "force_active",	INT_PARAM, &force_active },
104
+	{ "pidf_manipulation",  INT_PARAM, &pidf_manipulation},
105
+	{ "integrated_xcap_server", INT_PARAM, &integrated_xcap_server},
106
+	{ "xcap_server",     	STR_PARAM|USE_FUNC_PARAM,(void*)pxml_add_xcap_server},
107
+	{ 0, 0, 0}
98 108
 };
99 109
 
100 110
 static mi_export_t mi_cmds[] = {
... ...
@@ -104,18 +114,18 @@ static mi_export_t mi_cmds[] = {
104 114
 
105 115
 /** module exports */
106 116
 struct module_exports exports= {
107
-	"presence_xml",				/* module name */
108
-	 DEFAULT_DLFLAGS,           /* dlopen flags */
109
-	 0,  						/* exported functions */
110
-	 params,					/* exported parameters */
111
-	 0,							/* exported statistics */
112
-	 mi_cmds,					/* exported MI functions */
113
-	 0,							/* exported pseudo-variables */
114
-	 0,							/* extra processes */
115
-	 mod_init,					/* module initialization function */
116
-	 (response_function) 0,		/* response handling function */
117
- 	 destroy,					/* destroy function */
118
-	 child_init                 /* per-child init function */
117
+	"presence_xml",		/* module name */
118
+	 DEFAULT_DLFLAGS,	/* dlopen flags */
119
+	 0,  			/* exported functions */
120
+	 params,		/* exported parameters */
121
+	 0,			/* exported statistics */
122
+	 mi_cmds,		/* exported MI functions */
123
+	 0,			/* exported pseudo-variables */
124
+	 0,			/* extra processes */
125
+	 mod_init,		/* module initialization function */
126
+	 (response_function) 0,	/* response handling function */
127
+ 	 destroy,		/* destroy function */
128
+	 child_init		/* per-child init function */
119 129
 };
120 130
 	
121 131
 /**
... ...
@@ -26,6 +26,13 @@
26 26
  *  2007-04-18  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: Core
31
+ * \ref presence_xml.c
32
+ * \ingroup presence_xml
33
+ */
34
+
35
+
29 36
 #ifndef _PRES_XML_H_
30 37
 #define _PRES_XML_H_
31 38
 
... ...
@@ -26,6 +26,12 @@
26 26
  *  2007-04-11  initial version (anca)
27 27
  */
28 28
 
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: XCAP authentication
31
+ * \ingroup presence_xml
32
+ */
33
+
34
+
29 35
 #include <stdio.h>
30 36
 #include <stdlib.h>
31 37
 #include <string.h>
... ...
@@ -25,6 +25,13 @@
25 25
  * --------
26 26
  *  2007-04-12  initial version (anca)
27 27
  */
28
+
29
+/*! \file
30
+ * \brief OpenSER Presence_XML :: XCAP authentication
31
+ * \ref xcap_auth.c
32
+ * \ingroup presence_xml
33
+ */
34
+
28 35
 #ifndef _AUTH_XML_H_
29 36
 #define _AUTH_XML_H_
30 37