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

Daniel-Constantin Mierla miconda at gmail.com
Fri Aug 29 23:19:11 CEST 2014


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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Aug 29 23:14:19 2014 +0200

cdp: removed empty functions sections from docs

---

 modules/cdp/README            |   26 ++++++++++++++++++--------
 modules/cdp/doc/cdp_admin.xml |    9 ---------
 2 files changed, 18 insertions(+), 17 deletions(-)

diff --git a/modules/cdp/README b/modules/cdp/README
index a2e4ff4..882b004 100644
--- a/modules/cdp/README
+++ b/modules/cdp/README
@@ -33,9 +33,10 @@ Richard Good
               4.1. config_file (string)
               4.2. latency_threshold (int)
 
-        5. Functions
+        5. RPC Commands
 
-              5.1.
+              5.1. cdp.disable_peer
+              5.2. cdp.enable_peer
 
         6. Configuration Examples
 
@@ -138,9 +139,10 @@ Chapter 1. Admin Guide
         4.1. config_file (string)
         4.2. latency_threshold (int)
 
-   5. Functions
+   5. RPC Commands
 
-        5.1.
+        5.1. cdp.disable_peer
+        5.2. cdp.enable_peer
 
    6. Configuration Examples
 
@@ -225,12 +227,20 @@ modparam("cdp", "config_file", "/etc/kamailio/diametercfg.xml")
 modparam("cdp", "latency_threshold", 1000)
 ...
 
-5. Functions
+5. RPC Commands
 
-   5.1.
+   5.1. cdp.disable_peer
+   5.2. cdp.enable_peer
 
-   No functions available from configuration. See API for internal
-   functions.
+   exported RPC commands.
+
+5.1. cdp.disable_peer
+
+   instantly disable a particular diameter peer.
+
+5.2. cdp.enable_peer
+
+   enabe/re-enable a diameter peer
 
 6. Configuration Examples
 
diff --git a/modules/cdp/doc/cdp_admin.xml b/modules/cdp/doc/cdp_admin.xml
index 904b193..cdf65d2 100644
--- a/modules/cdp/doc/cdp_admin.xml
+++ b/modules/cdp/doc/cdp_admin.xml
@@ -129,15 +129,6 @@ modparam("cdp", "latency_threshold", 1000)
   </section>
 
   <section>
-    <title>Functions</title>
-
-    <section>
-      <para>No functions available from configuration. See API for internal
-      functions.</para>
-    </section>
-  </section>
-
-  <section>
     <title>RPC Commands</title>
 
     <para>exported RPC commands.</para>




More information about the sr-dev mailing list