[sr-dev] git:master: modules_s/print_lib: added readme and xml docbook files

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 8e806d4cb02049ffb447e3781d0ce864bb2bffb7
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8e806d4cb02049ffb447e3781d0ce864bb2bffb7

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Dec 21 17:57:12 2012 +0100

modules_s/print_lib: added readme and xml docbook files

---

 modules_s/print_lib/README            |   34 +++++++++++++++++++++++++++++
 modules_s/print_lib/doc/Makefile      |    4 +++
 modules_s/print_lib/doc/functions.xml |   34 +++++++++++++++++++++++++++++
 modules_s/print_lib/doc/print_lib.xml |   38 +++++++++++++++++++++++++++++++++
 4 files changed, 110 insertions(+), 0 deletions(-)

diff --git a/modules_s/print_lib/README b/modules_s/print_lib/README
new file mode 100644
index 0000000..f9fca80
--- /dev/null
+++ b/modules_s/print_lib/README
@@ -0,0 +1,34 @@
+1. Print_lib Module
+
+Andrei Pelinescu-Onciul
+
+   FhG FOKUS
+
+   Copyright © 2003 FhG FOKUS
+     __________________________________________________________________
+
+   1.1. Overview
+   1.2. Functions
+
+        1.2.1. print_stderr(txt)
+
+1.1. Overview
+
+   This is an example module. It implements only one function that prints
+   its string parameter to stderr (it won't work if server is started in
+   daemon mode). Its prupose is to show how to link to an internal library
+   (lib/print).
+
+1.2. Functions
+
+1.2.1. print_stderr(txt)
+
+   Prints string to stderr.
+
+   Meaning of the parameters is as follows:
+     * txt - string to be printed.
+
+   Example 1. print_stderr usage
+...
+print_stderr("The answer is 42\n");
+...
diff --git a/modules_s/print_lib/doc/Makefile b/modules_s/print_lib/doc/Makefile
new file mode 100644
index 0000000..a31d859
--- /dev/null
+++ b/modules_s/print_lib/doc/Makefile
@@ -0,0 +1,4 @@
+docs = print_lib.xml
+
+docbook_dir=../../../docbook
+include $(docbook_dir)/Makefile.module
diff --git a/modules_s/print_lib/doc/functions.xml b/modules_s/print_lib/doc/functions.xml
new file mode 100644
index 0000000..9ea81fe
--- /dev/null
+++ b/modules_s/print_lib/doc/functions.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<section id="print_lib.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
+    <sectioninfo>
+    </sectioninfo>
+
+    <title>Functions</title>
+
+    <section id="print_lib.print">
+	<title>
+	    <function>print_stderr(txt)</function>
+	</title>
+	<para>
+	    Prints string to stderr.
+	</para>
+	<para>Meaning of the parameters is as follows:</para>
+	<itemizedlist>
+	    <listitem>
+		<para><emphasis>txt</emphasis> - string to be printed.
+		</para>
+	    </listitem>
+	</itemizedlist>
+	<example>
+	    <title><function>print_stderr</function> usage</title>
+	    <programlisting>
+...
+print_stderr("The answer is 42\n");
+...
+	    </programlisting>
+	</example>
+    </section>
+</section>
diff --git a/modules_s/print_lib/doc/print_lib.xml b/modules_s/print_lib/doc/print_lib.xml
new file mode 100644
index 0000000..7674728
--- /dev/null
+++ b/modules_s/print_lib/doc/print_lib.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<section id="print" xmlns:xi="http://www.w3.org/2001/XInclude">
+    <sectioninfo>
+	<authorgroup>
+	    <author>
+		<firstname>Andrei</firstname>
+		<surname>Pelinescu-Onciul</surname>
+		<affiliation><orgname>FhG FOKUS</orgname></affiliation>
+		<address>
+		    <email>pelinescu-onciul at fokus.fhg.de</email>
+		</address>
+	    </author>
+	</authorgroup>
+	<copyright>
+	    <year>2003</year>
+	    <holder>FhG FOKUS</holder>
+	</copyright>
+    </sectioninfo>
+
+    <title>Print_lib Module</title>
+
+    <section id="print_lib.overview">
+	<title>Overview</title>
+	<para>
+	    This is an example module. It implements only one function that
+	    prints its string parameter to stderr (it won't work if server is
+		started in daemon mode). Its prupose is to show how to link to
+		an internal library (lib/print).
+	</para>
+    </section>
+    
+    <xi:include href="functions.xml"/>
+
+</section>
+