Sfoglia il codice sorgente

http_client Adding template for developer's guide

Olle E. Johansson 9 anni fa
parent
commit
c6f7edd4f6

+ 25 - 0
modules/http_client/README

@@ -64,6 +64,12 @@ Carsten Bock
               7.2. httpclient.connok
               7.3. httpclient.connfail
 
+   2. Developer Guide
+
+        1. Available Functions
+
+              1.1. http_client(name)
+
    List of Examples
 
    1.1. Set httpredirect parameter
@@ -482,3 +488,22 @@ switch ($retcode) {
 7.3. httpclient.connfail
 
    The number of failed connections since Kamailio start
+
+Chapter 2. Developer Guide
+
+   Table of Contents
+
+   1. Available Functions
+
+        1.1. http_client(name)
+
+1. Available Functions
+
+   1.1. http_client(name)
+
+1.1. http_client(name)
+
+   Text here
+
+   Meaning of the parameters is as follows:
+     * const char* name - Name of the stuff. (Hugh - fill in here)

+ 1 - 0
modules/http_client/doc/http_client.xml

@@ -54,6 +54,7 @@
 	<toc></toc>
 	
 	<xi:include href="http_client_admin.xml"/>
+	<xi:include href="http_client_devel.xml"/>
 	
 	
 </book>

+ 38 - 0
modules/http_client/doc/http_client_devel.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+<!-- Module Developer's Guide -->
+
+<chapter>
+	
+	<title>&develguide;</title>
+	<section>
+	<title>Available Functions</title>
+		<section>
+			<title>
+			<function moreinfo="none">http_client(name)</function>
+			</title>
+			<para>
+			Text here
+			</para>
+			<para>Meaning of the parameters is as follows:</para>
+			<itemizedlist>
+			<listitem>
+				<para><emphasis>const char* name</emphasis> - Name of the 
+					stuff. (Hugh - fill in here)
+				</para>
+			</listitem>
+			</itemizedlist>
+		</section>
+
+
+	</section>
+
+</chapter>
+