http_async_client Add doxygen templates
authorOlle E. Johansson <oej@edvina.net>
Sat, 13 Feb 2016 18:58:31 +0000 (19:58 +0100)
committerOlle E. Johansson <oej@edvina.net>
Sat, 13 Feb 2016 18:58:31 +0000 (19:58 +0100)
Please update with better descriptions

README
modules/http_async_client/async_http.c
modules/http_async_client/async_http.h
modules/http_async_client/hm_hash.c
modules/http_async_client/hm_hash.h
modules/http_async_client/http_async_client_mod.c
modules/http_async_client/http_multi.c
modules/http_async_client/http_multi.h

diff --git a/README b/README
index 6d9992b..bce8726 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 
 
-Kamailio v4.3
+Kamailio v4.4
 =============
 
 http://www.kamailio.org
index b761552..b45760f 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Include file
+ * \ingroup http_async_client
+ */
+
+
 #include <stdio.h>
 #include <unistd.h>
 #include <stdlib.h>
@@ -305,7 +311,7 @@ int async_send_query(sip_msg_t *msg, str *query, str *post, cfg_action_t *act)
        }
        memset(aq,0,dsize);
 
-    if(shm_str_dup(&aq->query, query)<0) {
+       if(shm_str_dup(&aq->query, query)<0) {
                goto error;
        }
 
@@ -361,17 +367,19 @@ int async_send_query(sip_msg_t *msg, str *query, str *post, cfg_action_t *act)
                goto error;
        }
 
-       if (suspend) 
+       if (suspend)  {
                /* force exit in config */
                return 0;
+       }
        
        /* continue route processing */
        return 1;
 
 error:
 
-       if (suspend)
+       if (suspend) {
                tmb.t_cancel_suspend(tindex, tlabel);
+       }
        free_async_query(aq);
        return -1;
 }
index 1b03537..bc4203f 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Async HTTP
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _ASYNC_HTTP_
 #define _ASYNC_HTTP_
 
index 6ee8071..9f4452d 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Hash functions
+ * \ingroup http_async_client
+ */
+
+
 #include "hm_hash.h"
 
 extern int hash_size;
@@ -53,6 +59,7 @@ int init_http_m_table(unsigned int size)
        LM_DBG("hash table %p initialized with size %d\n", hm_table, size);
        return 0;
 }
+
 unsigned int build_hash_key(void *p)
 {
        str                     *hash_str;
index 21015cb..97429a4 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Hash functions
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _HM_HASH_
 #define _HM_HASH_
 
index 3368818..7663af9 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: The module interface file
+ * \ingroup http_async_client
+ */
+
+/*! \defgroup http_async_client Kamailio :: Async module interface to Curl/HTTP
+ *
+ * http://curl.haxx.se
+ * A generic library for many protocols
+ *
+ */
+
 #include <stdio.h>
 #include <unistd.h>
 #include <stdlib.h>
index beda63b..d5767a1 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: multi interface
+ * \ingroup http_async_client
+ */
+
+
 #include "../../dprint.h"
 #include "../../mem/mem.h"
 #include "../../ut.h"
index 6c3fa21..74345c4 100644 (file)
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Multi interface
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _HTTP_MULTI_
 #define _HTTP_MULTI_