[sr-dev] git:master: statistics: minor update of docs

Olle E. Johansson oej at edvina.net
Thu Sep 25 21:45:56 CEST 2014


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

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Thu Sep 25 20:46:03 2014 +0200

statistics: minor update of docs

---

 modules/statistics/README                   |    5 +++--
 modules/statistics/doc/statistics_admin.xml |   16 ++++++++--------
 2 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/modules/statistics/README b/modules/statistics/README
index 04b1bbd..03798f0 100644
--- a/modules/statistics/README
+++ b/modules/statistics/README
@@ -107,7 +107,8 @@ modparam("statistics", "variable", "active_calls/no_reset")
    Meaning of the parameters is as follows:
      * variable - variable to be updated (it can be a string or a
        pseudovariable);
-     * value - value to update with; it may be also negative.
+     * value - value to update with; it may be also negative (it can be a
+       string or pseudovariable).
 
    This function can be used from ANY_ROUTE.
 
@@ -124,7 +125,7 @@ update_stat("$var(a_calls)", "-1");
    Resets to zero the value of the statistic variable.
 
    Meaning of the parameters is as follows:
-     * variable - variable to be reset-ed (it can be a string or a
+     * variable - variable to be reset (it can be a string or a
        pseudovariable).
 
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
diff --git a/modules/statistics/doc/statistics_admin.xml b/modules/statistics/doc/statistics_admin.xml
index 1e4dab5..4997d7b 100644
--- a/modules/statistics/doc/statistics_admin.xml
+++ b/modules/statistics/doc/statistics_admin.xml
@@ -9,7 +9,7 @@
 <chapter>
   <title>&adminguide;</title>
 
-  <section>
+  <section id="statistics.overview">
     <title>Overview</title>
 
     <para>The <acronym>Statistics</acronym> module is a wrapper over the
@@ -21,7 +21,7 @@
     implementation of any kind of statistic scenario.</para>
   </section>
 
-  <section>
+  <section id="statistics.dependencies">
     <title>Dependencies</title>
 
     <section>
@@ -48,10 +48,10 @@
     </section>
   </section>
 
-  <section>
+  <section id="statistics.parameters">
     <title>Parameters</title>
 
-    <section>
+    <section id="statistics.p.variable">
       <title><varname>variable</varname> (string)</title>
 
       <para>Name of a new statistic variable. The name may be followed by
@@ -75,10 +75,10 @@ modparam("statistics", "variable", "active_calls/no_reset")
     </section>
   </section>
 
-  <section>
+  <section id="statistics.functions">
     <title>Functions</title>
 
-    <section>
+    <section id="statistics.f.update_stat">
       <title><function
       moreinfo="none">update_stat(variable,value)</function></title>
 
@@ -115,7 +115,7 @@ update_stat("$var(a_calls)", "-1");
       </example>
     </section>
 
-    <section>
+    <section id="statistics.f.reset_stat">
       <title><function moreinfo="none">reset_stat(variable)</function></title>
 
       <para>Resets to zero the value of the statistic variable.</para>
@@ -124,7 +124,7 @@ update_stat("$var(a_calls)", "-1");
 
       <itemizedlist>
         <listitem>
-          <para><emphasis>variable</emphasis> - variable to be reset-ed (it
+          <para><emphasis>variable</emphasis> - variable to be reset (it
           can be a string or a pseudovariable).</para>
         </listitem>
       </itemizedlist>




More information about the sr-dev mailing list