瀏覽代碼

http_client: docs - section title to get proper entry in toc

- bits of whitespacing fixing
Daniel-Constantin Mierla 4 年之前
父節點
當前提交
fadc0fc499

+ 2 - 3
src/modules/http_client/doc/http_client.xml

@@ -56,9 +56,8 @@
 	</copyright>
 	</copyright>
 	</bookinfo>
 	</bookinfo>
 	<toc></toc>
 	<toc></toc>
-	
+
 	<xi:include href="http_client_admin.xml"/>
 	<xi:include href="http_client_admin.xml"/>
 	<xi:include href="http_client_devel.xml"/>
 	<xi:include href="http_client_devel.xml"/>
-	
-	
+
 </book>
 </book>

+ 7 - 8
src/modules/http_client/doc/http_client_admin.xml

@@ -74,8 +74,7 @@
 		<title>External Libraries or Applications</title>
 		<title>External Libraries or Applications</title>
 		<para>
 		<para>
 		The following libraries or applications must be
 		The following libraries or applications must be
-		installed before  
-		running &kamailio; with this module loaded:
+		installed before running &kamailio; with this module loaded:
 			<itemizedlist>
 			<itemizedlist>
 			<listitem>
 			<listitem>
 			<para>
 			<para>
@@ -86,7 +85,7 @@
 		</para>
 		</para>
 	</section>
 	</section>
 	</section>
 	</section>
-	
+
 	<section>
 	<section>
 		<title>Parameters</title>
 		<title>Parameters</title>
 		<section id="http_client.p.httpredirect">
 		<section id="http_client.p.httpredirect">
@@ -297,7 +296,7 @@ modparam("http_client", "cipher_suites", "ecdhe_ecdsa_aes_128_gcm_sha_256,rsa_ae
 			<title><varname>verify_peer</varname> (int)</title>
 			<title><varname>verify_peer</varname> (int)</title>
 			<para>
 			<para>
 			If set to 0, TLS verification of the server certificate
 			If set to 0, TLS verification of the server certificate
-			is disabled. This means that the connection will get 
+			is disabled. This means that the connection will get
 			encrypted, but there's no authentication. There's no
 			encrypted, but there's no authentication. There's no
 			proof that the transmission of data is to the host
 			proof that the transmission of data is to the host
 			that is meant to receive data.
 			that is meant to receive data.
@@ -324,7 +323,7 @@ modparam("http_client", "verify_peer", 1)
 			<title><varname>verify_host</varname> (int)</title>
 			<title><varname>verify_host</varname> (int)</title>
 			<para>
 			<para>
 			If set to 0, domain verification of the server certificate
 			If set to 0, domain verification of the server certificate
-			is disabled. This means that the connection will get 
+			is disabled. This means that the connection will get
 			encrypted but there is no check that data will be sent to the
 			encrypted but there is no check that data will be sent to the
 			host that is meant to receive it. Disable with caution.
 			host that is meant to receive it. Disable with caution.
 			</para>
 			</para>
@@ -535,11 +534,11 @@ modparam("http_client", "query_maxdatasize", 2048)
 				Overrides the default cipher_suite modparam.
 				Overrides the default cipher_suite modparam.
 				</para></listitem>
 				</para></listitem>
 				<listitem><para>
 				<listitem><para>
-				<emphasis>timeout</emphasis> Timeout used for this connection. Overrides the 
+				<emphasis>timeout</emphasis> Timeout used for this connection. Overrides the
 				default connection_timeout for the module.
 				default connection_timeout for the module.
 				</para></listitem>
 				</para></listitem>
 				<listitem><para>
 				<listitem><para>
-				<emphasis>tlsversion</emphasis> TLS version used for this connection. Overrides the 
+				<emphasis>tlsversion</emphasis> TLS version used for this connection. Overrides the
 				default tlsversion for the module.
 				default tlsversion for the module.
 				</para></listitem>
 				</para></listitem>
 				<listitem><para>
 				<listitem><para>
@@ -648,7 +647,7 @@ modparam("http_client", "config_file", "httpconnections.cfg)
 [authapiserver]
 [authapiserver]
 url = https://api.runbo.example.com/v4.2/auth
 url = https://api.runbo.example.com/v4.2/auth
 timeout = 1
 timeout = 1
-maxdatasize = 4 
+maxdatasize = 4
 tlsversion = TLSv1.2
 tlsversion = TLSv1.2
 verify_peer = yes
 verify_peer = yes
 client_key = default_key.pem
 client_key = default_key.pem

+ 5 - 3
src/modules/http_client/doc/http_client_devel.xml

@@ -10,11 +10,14 @@
 <!-- Module Developer's Guide -->
 <!-- Module Developer's Guide -->
 
 
 <chapter>
 <chapter>
-	
+
 	<title>&develguide;</title>
 	<title>&develguide;</title>
 	<section>
 	<section>
+	<title>Introduction</title>
+	<para>
 	This module provides a set of API functions that other modules can use in order to
 	This module provides a set of API functions that other modules can use in order to
 	integrate with HTTP services.
 	integrate with HTTP services.
+	</para>
 	</section>
 	</section>
 	<section>
 	<section>
 	<title>Available Functions</title>
 	<title>Available Functions</title>
@@ -93,7 +96,7 @@
 			<function moreinfo="none">int http_query(msg, url, dest, post)</function>
 			<function moreinfo="none">int http_query(msg, url, dest, post)</function>
 			</title>
 			</title>
 			<para>
 			<para>
-			Sends a 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
 			is defined, POST will be used, otherwise GET. The default settings
 			defined as module params of the http_client module will be used for
 			defined as module params of the http_client module will be used for
 			the connection.
 			the connection.
@@ -144,7 +147,6 @@
 			</para>
 			</para>
 		</section>
 		</section>
 
 
-
 	</section>
 	</section>
 
 
 </chapter>
 </chapter>