- doxygen, formatting changes and small changes in startup error msg
authorHenning Westerholt <henning.westerholt@1und1.de>
Wed, 23 Jul 2008 15:59:12 +0000 (15:59 +0000)
committerHenning Westerholt <henning.westerholt@1und1.de>
Wed, 23 Jul 2008 15:59:12 +0000 (15:59 +0000)
- patch provided from Olle E. Johansson, closes #2024503

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

18 files changed:
modules_k/presence/bind_presence.c
modules_k/presence/bind_presence.h
modules_k/presence/event_list.c
modules_k/presence/event_list.h
modules_k/presence/hash.c
modules_k/presence/hash.h
modules_k/presence/notify.c
modules_k/presence/notify.h
modules_k/presence/presence.c
modules_k/presence/presence.h
modules_k/presence/presentity.c
modules_k/presence/presentity.h
modules_k/presence/publish.c
modules_k/presence/publish.h
modules_k/presence/subscribe.c
modules_k/presence/subscribe.h
modules_k/presence/utils_func.c
modules_k/presence/utils_func.h

index e93a0ae..9c4bc0c 100644 (file)
  *  2007-04-17  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module
+ * \ingroup presence
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include "../../dprint.h"
@@ -46,11 +51,11 @@ int bind_presence(presence_api_t* api)
        api->get_event_list= get_event_list;
        api->update_watchers_status= update_watchers_status;
        api->new_shtable= new_shtable;
-    api->destroy_shtable= destroy_shtable;
-    api->insert_shtable= insert_shtable;
-    api->search_shtable= search_shtable;
-    api->delete_shtable= delete_shtable;
-    api->update_shtable= update_shtable;
+       api->destroy_shtable= destroy_shtable;
+       api->insert_shtable= insert_shtable;
+       api->search_shtable= search_shtable;
+       api->delete_shtable= delete_shtable;
+       api->update_shtable= update_shtable;
        api->mem_copy_subs= mem_copy_subs;
        api->update_db_subs= update_db_subs;
        api->extract_sdialog_info= extract_sdialog_info;
index d83ee82..327fdb0 100644 (file)
  *  2007-04-17  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module
+ * \ingroup presence 
+ */
+
+
 #ifndef _PRES_BIND_H_
 #define _PRES_BIND_H_
 
index ff22aae..452454c 100644 (file)
  *  2007-04-04  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module
+ * \ref event_list.h
+ * \ingroup presence 
+ */
+
+
 #include <stdlib.h>
 #include<stdio.h>
 #include <string.h>
index a67f5c1..6f919c6 100644 (file)
  *  2007-04-05  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Events
+ * \ingroup presence 
+ */
+
+
 #ifndef _PRES_EV_LST_H
 #define  _PRES_EV_LST_H
 
index 405690f..6bf8050 100644 (file)
  *  2007-08-20  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module
+ * \ingroup presence 
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include "../../mem/shm_mem.h"
index d75c55e..e6623b8 100644 (file)
  *  2007-08-20  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Hash tables
+ * \ingroup presence 
+ */
+
+
 
 #ifndef PS_HASH_H
 #define PS_HASH_H
index 17b262c..3e042dc 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Notification with SIP NOTIFY
+ * \ingroup presence 
+ */
+
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
index 37f53fd..6da95b0 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: NOTIFY support
+ * \ingroup presence 
+ */
+
+
 #include "../../str.h"
 #include "../tm/dlg.h"
 #include "subscribe.h"
index 08a440c..bb35357 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \defgroup presence
+ *  \brief A generic implementation of the SIP event package (PUBLISH, SUBSCRIBE, NOTIFY)
+ *
+ *        The OpenSER 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 OpenSER presence module
+ * 
+ * \ingroup presence 
+ */
+
+
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
@@ -146,18 +163,18 @@ static mi_export_t mi_cmds[] = {
 
 /** module exports */
 struct module_exports exports= {
-       "presence",                                     /* module name */
-       DEFAULT_DLFLAGS,                        /* dlopen flags */
-       cmds,                                           /* exported functions */
-       params,                                         /* exported parameters */
-       0,                                                      /* exported statistics */
-       mi_cmds,                                        /* exported MI functions */
-       0,                                                      /* exported pseudo-variables */
-       0,                                                      /* extra processes */
-       mod_init,                                       /* module initialization function */
-       (response_function) 0,      /* response handling function */
-       (destroy_function) destroy, /* destroy function */
-       child_init                  /* per-child init function */
+       "presence",                     /* module name */
+       DEFAULT_DLFLAGS,                /* dlopen flags */
+       cmds,                           /* exported functions */
+       params,                         /* exported parameters */
+       0,                              /* exported statistics */
+       mi_cmds,                        /* exported MI functions */
+       0,                              /* exported pseudo-variables */
+       0,                              /* extra processes */
+       mod_init,                       /* module initialization function */
+       (response_function) 0,          /* response handling function */
+       (destroy_function) destroy,     /* destroy function */
+       child_init                      /* per-child init function */
 };
 
 /**
@@ -176,7 +193,7 @@ static int mod_init(void)
        if(db_url.s== NULL)
        {
                use_db= 0;
-               LM_DBG("presence module used for library purpose only\n");
+               LM_DBG("Presence module used for API library purpose only\n");
                EvList= init_evlist();
                if(!EvList)
                {
@@ -207,14 +224,14 @@ static int mod_init(void)
        /* load SL API */
        if(load_sl_api(&slb)==-1)
        {
-               LM_ERR("can't load sl functions\n");
+               LM_ERR("Can't load sl functions. Module SL not loaded?\n");
                return -1;
        }
 
        /* load all TM stuff */
        if(load_tm_api(&tmb)==-1)
        {
-               LM_ERR("can't load tm functions\n");
+               LM_ERR("Can't load tm functions. Module TM not loaded?\n");
                return -1;
        }
        
@@ -236,7 +253,7 @@ static int mod_init(void)
        pa_db = pa_dbf.init(&db_url);
        if (!pa_db)
        {
-               LM_ERR("connecting to database failed\n");
+               LM_ERR("Connection to database failed\n");
                return -1;
        }
        
@@ -443,7 +460,7 @@ static int fixup_presence(void** param, int param_no)
        return E_UNSPEC;
 }
 
-/* 
+/*! \brief
  *  mi cmd: refreshWatchers
  *                     <presentity_uri> 
  *                     <event>
index ae24130..e0f96c7 100644 (file)
  *  2006-10-09  first version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Core
+ * \ingroup presence 
+ */
+
+
 #ifndef PA_MOD_H
 #define PA_MOD_H
 
index 8adbf0f..d8dbed4 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Presentity handling
+ * \ingroup presence 
+ */
+
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
index 50415d7..0e71ef3 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Presentity handling
+ * \ref presentity.c
+ * \ingroup presence 
+ */
+
+
 #ifndef PRESENTITY_H
 #define PRESENTITY_H
 
index 95bbaa9..97c31bc 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Support for PUBLISH handling
+ * \ingroup presence 
+ */
+
+
 #include <time.h>
 
 #include "../../ut.h"
index c00312e..407e5da 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: PUBLISH support
+ * \ref publish.c
+ * \ingroup presence 
+ */
+
+
 #ifndef PUBLISH_H
 #define PUBLISH_H
 
index bcb3ee9..172d905 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Support for SUBSCRIBE handling
+ * \ingroup presence 
+ */
+
+
 #include "../../ut.h"
 #include "../../usr_avp.h"
 #include "../../data_lump_rpl.h"
index 5402a2f..88864d3 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: SUBSCRIBE support
+ * \ref subscribe.c
+ * \ingroup presence 
+ */
+
+
 #ifndef SUBSCRIBE_H
 #define SUBSCRIBE_H
 
index 87da4a2..8f20c80 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Utilities
+ * \ingroup presence 
+ */
+
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
index 394c86f..1af39a0 100644 (file)
  *  2006-08-15  initial version (anca)
  */
 
+/*! \file
+ * \brief OpenSER presence module :: Utility functions
+ * \ref utils_func.c
+ * \ingroup presence 
+ */
+
+
 
 #ifndef UTILS_FUNC_H
 #define UTILS_FUNC_H