git:master: sdpops: added module documentation - sr-dev

13 Mar 2011

Module: sip-router
Branch: master
Commit: d0e8c06af3a119b4ea5ba6c1881b23b3f9113c0d
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d0e8c06a...
Author: Daniel-Constantin Mierla miconda@gmail.com
Committer: Daniel-Constantin Mierla miconda@gmail.com
Date:   Sun Mar 13 10:51:01 2011 +0100
sdpops: added module documentation
---
modules/sdpops/README               |   97 +++++++++++++++++++++++++++++++++++
 modules/sdpops/doc/Makefile         |    4 ++
 modules/sdpops/doc/sdpops.xml       |   37 +++++++++++++
 modules/sdpops/doc/sdpops_admin.xml |   95 ++++++++++++++++++++++++++++++++++
 4 files changed, 233 insertions(+), 0 deletions(-)

diff --git a/modules/sdpops/README b/modules/sdpops/README
new file mode 100644
index 0000000..50630f7
--- /dev/null
+++ b/modules/sdpops/README
@@ -0,0 +1,97 @@
+SDPOPS Module
+
+Daniel-Constantin Mierla
+
+   miconda@gmail.com
+
+Edited by
+
+Daniel-Constantin Mierla
+
+   miconda@gmail.com
+
+   Copyright © 2011 asipto.com
+     __________________________________________________________________
+
+   Table of Contents
+
+   1. Admin Guide
+
+        1. Overview
+        2. Dependencies
+
+              2.1. Kamailio Modules
+              2.2. External Libraries or Applications
+
+        3. Exported Parameters
+        4. Exported Functions
+
+              4.1. sdp_remove_codecs_by_id(list)
+
+   List of Examples
+
+   1.1. sdp_remove_codecs_by_id usage
+
+Chapter 1. Admin Guide
+
+   Table of Contents
+
+   1. Overview
+   2. Dependencies
+
+        2.1. Kamailio Modules
+        2.2. External Libraries or Applications
+
+   3. Exported Parameters
+   4. Exported Functions
+
+        4.1. sdp_remove_codecs_by_id(list)
+
+1. Overview
+
+   This module provides function for checking and managing the SDP
+   payloads of SIP messages.
+
+   Examples of what this module offers: remove codecs from SDP, check the
+   media stream types, return attributes of SDP document. For the full
+   least of the features provided by this module and the implementation
+   state, read further to the list of exported functions.
+
+2. Dependencies
+
+   2.1. Kamailio Modules
+   2.2. External Libraries or Applications
+
+2.1. Kamailio Modules
+
+   The following modules must be loaded before this module:
+     * none.
+
+2.2. External Libraries or Applications
+
+   The following libraries or applications must be installed before
+   running Kamailio with this module loaded:
+     * None
+
+3. Exported Parameters
+
+   The module does not export any config parameter yet.
+
+4. Exported Functions
+
+   4.1. sdp_remove_codecs_by_id(list)
+
+4.1.  sdp_remove_codecs_by_id(list)
+
+   Remove the codecs provided in the parameter 'list' from all media
+   streams found in SDP payload. The parameter 'list' must be one or a
+   comma separated list of numeric codec IDs. The parameter can be a
+   static string or a variable holding the list of numeric codec IDs.
+
+   Example 1.1. sdp_remove_codecs_by_id usage
+...
+# remove PCMU
+sdp_remove_codecs_by_id("0");
+# remove PCMU, PCMA and GSM
+sdp_remove_codecs_by_id("0,8,3");
+...
diff --git a/modules/sdpops/doc/Makefile b/modules/sdpops/doc/Makefile
new file mode 100644
index 0000000..6fae5ba
--- /dev/null
+++ b/modules/sdpops/doc/Makefile
@@ -0,0 +1,4 @@
+docs = sdpops.xml
+
+docbook_dir = ../../../docbook
+include $(docbook_dir)/Makefile.module
diff --git a/modules/sdpops/doc/sdpops.xml b/modules/sdpops/doc/sdpops.xml
new file mode 100644
index 0000000..33771e5
--- /dev/null
+++ b/modules/sdpops/doc/sdpops.xml
@@ -0,0 +1,37 @@
+<?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;
+
+]>
+
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
+    <bookinfo>
+	<title>SDPOPS Module</title>
+	<productname class="trade">sip-router.org</productname>
+	<authorgroup>
+	    <author>
+		<firstname>Daniel-Constantin</firstname>
+		<surname>Mierla</surname>
+		<email>miconda@gmail.com</email>
+	    </author>
+	    <editor>
+		<firstname>Daniel-Constantin</firstname>
+		<surname>Mierla</surname>
+		<email>miconda@gmail.com</email>
+	    </editor>
+	</authorgroup>
+	<copyright>
+	    <year>2011</year>
+	    <holder>asipto.com</holder>
+	</copyright>
+    </bookinfo>
+    <toc></toc>
+    
+    <xi:include href="sdpops_admin.xml"/>
+    
+    
+</book>
diff --git a/modules/sdpops/doc/sdpops_admin.xml b/modules/sdpops/doc/sdpops_admin.xml
new file mode 100644
index 0000000..4981c07
--- /dev/null
+++ b/modules/sdpops/doc/sdpops_admin.xml
@@ -0,0 +1,95 @@
+<?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 User's Guide -->
+
+<chapter>
+	
+	<title>&adminguide;</title>
+	
+	<section>
+	<title>Overview</title>
+	<para>
+		This module provides function for checking and managing the SDP
+		payloads of SIP messages.
+	</para>
+	<para>
+		Examples of what this module offers: remove codecs from SDP,
+		check the media stream types, return attributes of SDP document.
+		For the full least of the features provided by this module and
+		the implementation state, read further to the list of exported
+		functions.
+	</para>
+	</section>
+
+	<section>
+	<title>Dependencies</title>
+	<section>
+		<title>&kamailio; Modules</title>
+		<para>
+		The following modules must be loaded before this module:
+			<itemizedlist>
+			<listitem>
+			<para>
+				<emphasis>none</emphasis>.
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+	</section>
+	<section>
+		<title>External Libraries or Applications</title>
+		<para>
+		The following libraries or applications must be installed before running
+		&kamailio; with this module loaded:
+			<itemizedlist>
+			<listitem>
+			<para>
+				<emphasis>None</emphasis>
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+	</section>
+	</section>
+	<section>
+	<title>Exported Parameters</title>
+		<para>
+		The module does not export any config parameter yet.
+		</para>
+	</section>
+
+	<section>
+	<title>Exported Functions</title>
+ 	<section>
+	    <title>
+		<function moreinfo="none">sdp_remove_codecs_by_id(list)</function>
+	    </title>
+	    <para>
+			Remove the codecs provided in the parameter 'list' from all
+			media streams found in SDP payload. The parameter 'list' must
+			be one or a comma separated list of numeric codec IDs. The
+			parameter can be a static string or a variable holding the
+			list of numeric codec IDs.
+	    </para>
+		<example>
+		<title><function>sdp_remove_codecs_by_id</function> usage</title>
+		<programlisting format="linespecific">
+...
+# remove PCMU
+sdp_remove_codecs_by_id("0");
+# remove PCMU, PCMA and GSM
+sdp_remove_codecs_by_id("0,8,3");
+...
+</programlisting>
+	    </example>
+	</section>
+	</section>
+</chapter>
+

    