[sr-dev] git:master:2fb7bd77: http_client Update devel documentation

Olle E. Johansson oej at edvina.net
Mon Jan 2 17:18:04 CET 2017


Module: kamailio
Branch: master
Commit: 2fb7bd770977e748efd2be90147a44ac96731285
URL: https://github.com/kamailio/kamailio/commit/2fb7bd770977e748efd2be90147a44ac96731285

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: 2017-01-02T17:17:38+01:00

http_client Update devel documentation

---

Modified: src/modules/http_client/doc/http_client_devel.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/2fb7bd770977e748efd2be90147a44ac96731285.diff
Patch: https://github.com/kamailio/kamailio/commit/2fb7bd770977e748efd2be90147a44ac96731285.patch

---

diff --git a/src/modules/http_client/doc/http_client_devel.xml b/src/modules/http_client/doc/http_client_devel.xml
index 049d107..80bb99b 100644
--- a/src/modules/http_client/doc/http_client_devel.xml
+++ b/src/modules/http_client/doc/http_client_devel.xml
@@ -13,10 +13,14 @@
 	
 	<title>&develguide;</title>
 	<section>
+	This module provides a set of API functions that other modules can use in order to
+	integrate with HTTP services.
+	</section>
+	<section>
 	<title>Available Functions</title>
 		<section>
 			<title>
-			<function moreinfo="none">http_connect(msg, connection, url, result, content_type, post)</function>
+			<function moreinfo="none">int http_connect(msg, connection, url, result, content_type, post)</function>
 			</title>
 			<para>
 			Sends HTTP GET or POST request to a given connection. If content_type and post
@@ -86,10 +90,10 @@
 		</section>
 		<section>
 			<title>
-			<function moreinfo="none">http_query(msg, url, dest, post)</function>
+			<function moreinfo="none">int http_query(msg, url, dest, post)</function>
 			</title>
 			<para>
-			Sends HTTP GET or POST request to a given connection. If post data 
+			Sends a HTTP GET or POST request to a given connection. If post data 
 			is defined, POST will be used, otherwise GET. The default settings
 			defined as module params of the http_client module will be used for
 			the connection.
@@ -99,7 +103,7 @@
 			<listitem>
 				<para><emphasis>struct sip_msg *msg</emphasis></para>
 				<para>
-				The current sip message structure.
+				The current SIP message structure.
 				</para>
 			</listitem>
 			<listitem>




More information about the sr-dev mailing list