[sr-dev] git:master:c6f7edd4: http_client Adding template for developer's guide

Module: kamailio Branch: master Commit: c6f7edd4f644388a4b35bca9d9d8f4880b6b4620 URL: https://github.com/kamailio/kamailio/commit/c6f7edd4f644388a4b35bca9d9d8f48… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: 2016-02-03T13:47:05+01:00 http_client Adding template for developer's guide --- Added: modules/http_client/doc/http_client_devel.xml Modified: modules/http_client/README Modified: modules/http_client/doc/http_client.xml --- Diff: https://github.com/kamailio/kamailio/commit/c6f7edd4f644388a4b35bca9d9d8f48… Patch: https://github.com/kamailio/kamailio/commit/c6f7edd4f644388a4b35bca9d9d8f48… --- diff --git a/modules/http_client/README b/modules/http_client/README index ac96665..88c4d80 100644 --- a/modules/http_client/README +++ b/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) diff --git a/modules/http_client/doc/http_client.xml b/modules/http_client/doc/http_client.xml index 09a23bd..5aed165 100644 --- a/modules/http_client/doc/http_client.xml +++ b/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> diff --git a/modules/http_client/doc/http_client_devel.xml b/modules/http_client/doc/http_client_devel.xml new file mode 100644 index 0000000..d4f83ed --- /dev/null +++ b/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> +