http_async_client Add doxygen templates

Please update with better descriptions
kamailio · Feb 13, 2016 · 0841c45 · 0841c45
1 parent f0d0075
commit 0841c45
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 4 deletions.
diff --git a/README b/README
@@ -1,6 +1,6 @@
 
 
-Kamailio v4.3
+Kamailio v4.4
 =============
 
 http://www.kamailio.org

diff --git a/modules/http_async_client/async_http.c b/modules/http_async_client/async_http.c
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \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;
 }

diff --git a/modules/http_async_client/async_http.h b/modules/http_async_client/async_http.h
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Async HTTP
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _ASYNC_HTTP_
 #define _ASYNC_HTTP_
 

diff --git a/modules/http_async_client/hm_hash.c b/modules/http_async_client/hm_hash.c
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \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;

diff --git a/modules/http_async_client/hm_hash.h b/modules/http_async_client/hm_hash.h
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Hash functions
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _HM_HASH_
 #define _HM_HASH_
 

diff --git a/modules/http_async_client/http_async_client_mod.c b/modules/http_async_client/http_async_client_mod.c
@@ -22,6 +22,18 @@
  *
  */
 
+/*! \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>

diff --git a/modules/http_async_client/http_multi.c b/modules/http_async_client/http_multi.c
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: multi interface
+ * \ingroup http_async_client
+ */
+
+
 #include "../../dprint.h"
 #include "../../mem/mem.h"
 #include "../../ut.h"

diff --git a/modules/http_async_client/http_multi.h b/modules/http_async_client/http_multi.h
@@ -22,6 +22,12 @@
  *
  */
 
+/*! \file
+ * \brief  Kamailio http_async_client :: Multi interface
+ * \ingroup http_async_client
+ */
+
+
 #ifndef _HTTP_MULTI_
 #define _HTTP_MULTI_