[sr-dev] git:master: pua_mi: removed empty sections from docs

Daniel-Constantin Mierla miconda at gmail.com
Mon Oct 13 12:33:20 CEST 2014


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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Mon Oct 13 12:32:08 2014 +0200

pua_mi: removed empty sections from docs

- updated title for mi commands sections to match indexing expected
  value (reported by Juha Heinanen)

---

 modules/pua_mi/README               |   37 +++++++++++-----------------------
 modules/pua_mi/doc/pua_mi_admin.xml |   18 +----------------
 2 files changed, 13 insertions(+), 42 deletions(-)

diff --git a/modules/pua_mi/README b/modules/pua_mi/README
index ce35e0b..bfeaccf 100644
--- a/modules/pua_mi/README
+++ b/modules/pua_mi/README
@@ -12,7 +12,7 @@ Edited by
 
 Juha Heinanen
 
-   Copyright (c) 2006 Voice Sistem SRL
+   Copyright © 2006 Voice Sistem SRL
      __________________________________________________________________
 
    Table of Contents
@@ -25,12 +25,10 @@ Juha Heinanen
               2.1. Kamailio Modules
               2.2. External Libraries or Applications
 
-        3. Parameters
-        4. Functions
-        5. Exported MI functions
+        3. MI Commands
 
-              5.1. pua_publish
-              5.2. pua_subscribe
+              3.1. pua_publish
+              3.2. pua_subscribe
 
    List of Examples
 
@@ -46,12 +44,10 @@ Chapter 1. Admin Guide
         2.1. Kamailio Modules
         2.2. External Libraries or Applications
 
-   3. Parameters
-   4. Functions
-   5. Exported MI functions
+   3. MI Commands
 
-        5.1. pua_publish
-        5.2. pua_subscribe
+        3.1. pua_publish
+        3.2. pua_subscribe
 
 1. Overview
 
@@ -80,21 +76,12 @@ Chapter 1. Admin Guide
    running Kamailio with this module loaded:
      * none
 
-3. Parameters
+3. MI Commands
 
-     * none
-
-4. Functions
-
-   The module does not export functions to be used in configuration
-   script.
-
-5. Exported MI functions
-
-   5.1. pua_publish
-   5.2. pua_subscribe
+   3.1. pua_publish
+   3.2. pua_subscribe
 
-5.1.  pua_publish
+3.1. pua_publish
 
    Command parameters:
      * presentity_uri - e.g. sip:system at kamailio.org
@@ -134,7 +121,7 @@ le id='0x81475a0'><status><basic>open</basic></status></tuple><dm:person id='pdd
 748945'><rpid:activities><rpid:away/>away</rpid:activities><dm:note>CPU:16 MEM:4
 76</dm:note></dm:person></presence>
 
-5.2.  pua_subscribe
+3.2. pua_subscribe
 
    Command parameters:
      * presentity_uri - e.g. sip:presentity at kamailio.org
diff --git a/modules/pua_mi/doc/pua_mi_admin.xml b/modules/pua_mi/doc/pua_mi_admin.xml
index 56cec44..f10c42f 100644
--- a/modules/pua_mi/doc/pua_mi_admin.xml
+++ b/modules/pua_mi/doc/pua_mi_admin.xml
@@ -65,23 +65,7 @@
 	</section>
 	
 	<section>
-		<title>Parameters</title>
-		<itemizedlist>
-			<listitem>
-			<para>
-				<emphasis>none</emphasis>
-			</para>
-			</listitem>
-		</itemizedlist>	
-	</section>	
-
-	<section>
-		<title>Functions</title>
-		<para>The module does not export functions to be used
-		in configuration script.</para>
-	</section>	
-	<section>
-		<title>Exported MI functions</title>
+		<title>MI Commands</title>
 		<section>
 				<title>
 				<function moreinfo="none">pua_publish</function>




More information about the sr-dev mailing list