Rebuild documentation

OpenSIPS · Aug 4, 2019 · 518aca4 · 518aca4
1 parent 478291e
commit 518aca4
Show file tree

Hide file tree

Showing 20 changed files with 220 additions and 223 deletions.
diff --git a/modules/acc/README b/modules/acc/README
@@ -64,7 +64,7 @@ Acc Module
 
         1.8. Exported Functions
 
-              1.8.1. do_accounting(type, flags, table)
+              1.8.1. do_accounting(type, [flags], [table])
               1.8.2. drop_accounting([type], [flags])
               1.8.3. acc_log_request(comment)
               1.8.4. acc_db_request(comment, table)
@@ -658,7 +658,7 @@ $(acc_leg(caller)[-2])
 
 1.8. Exported Functions
 
-1.8.1.  do_accounting(type, flags, table)
+1.8.1.  do_accounting(type, [flags], [table])
 
    do_accounting() replaces all the *_flag and, *_missed_flag,
    cdr_flag, failed transaction_flag and the db_table_avp
@@ -667,16 +667,16 @@ $(acc_leg(caller)[-2])
    the work for you.
 
    Meaning of the parameters is as follows:
-     * type - the type of accounting you want to do. All types
-       have to be separated by '|'. The following parameters can
-       be used:
+     * type (string) - the type of accounting you want to do. All
+       types have to be separated by '|'. The following parameters
+       can be used:
           + log - syslog accounting;
           + db - database accounting;
           + aaa - aaa specific accounting;
           + evi - Event Interface accounting;
-     * flags - flags for the accounting type you have selected.
-       All the types have to be separated by '|'. The following
-       parameters can be used:
+     * flags (string, optional) - flags for the accounting type
+       you have selected. All the types have to be separated by
+       '|'. The following parameters can be used:
           + cdr - enables dialog-level accounting. OpenSIPS will
             internally detect dialog termination
             (generation/receipt of a BYE request), and store the
@@ -692,8 +692,8 @@ $(acc_leg(caller)[-2])
           + failed - flag which indicates if the transaction
             should also be accounted in case of failure
             (status>=300);
-     * table - table where to do the accounting; it replaces old
-       table_avp parameter;
+     * table (string, optional) - table where to do the
+       accounting; it replaces old table_avp parameter;
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and LOCAL_ROUTE.
@@ -726,16 +726,16 @@ y_acc");
    arguments normal accounting will still be enabled.
 
    Meaning of the parameters is as follows:
-     * type - the type of accounting you want to stop. All the
-       types have to be separated by '|'. The following parameters
-       can be used:
+     * type (string, optional) - the type of accounting you want
+       to stop. All the types have to be separated by '|'. The
+       following parameters can be used:
           + log - stop syslog accounting;
           + db - stop database accounting;
           + aaa - stop aaa specific accounting;
           + evi - stop Event Interface accounting;
-     * flags - flags to be reset for the accouting type you have
-       selected. All the types have to be separated by '|'. The
-       following parameters can be used:
+     * flags (string, optional) - flags to be reset for the
+       accouting type you have selected. All the types have to be
+       separated by '|'. The following parameters can be used:
           + cdr - stop CDR accounting;
           + missed - stop logging missed calls;
           + failed - stop failed transaction accounting;
@@ -764,7 +764,7 @@ y_acc");
                         /* or stop missed calls and cdr accounting for s
 yslog;
                          * normal accounting will still be enabled */
-                        drop_accounting("log","missed|cdr");
+                        drop_accounting("log", "missed|cdr");
                         /* or stop all types of accounting  */
                         drop_accounting();
                 }
@@ -779,10 +779,10 @@ yslog;
    processing.
 
    Meaning of the parameters is as follows:
-     * comment - Comment describing how the request completed -
-       this string has to contain a reply code followed by a reply
-       reason phrase (ex: "404 Nobody home"). Variables are
-       accepted in this string.
+     * comment (string) - Comment describing how the request
+       completed - this string has to contain a reply code
+       followed by a reply reason phrase (ex: "480 Nobody Home").
+       Variables are accepted in this string.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and LOCAL_ROUTE.
@@ -799,19 +799,19 @@ acc_log_request("403 Destination not allowed");
    to in the second action parameter.
 
    Meaning of the parameters is as follows:
-     * comment - Comment describing how the request completed -
-       this string has to contain a reply code followed by a reply
-       reason phrase (ex: "404 Nobody home"). Variables are
-       accepted in this string.
-     * table - Database table to be used.
+     * comment (string) - Comment describing how the request
+       completed - this string has to contain a reply code
+       followed by a reply reason phrase (ex: "480 Nobody Home").
+       Variables are accepted in this string.
+     * table (string) - Database table to be used.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and LOCAL_ROUTE.
 
    Example 1.24. acc_db_request usage
 ...
 acc_db_request("Some comment", "Some table");
-acc_db_request("$T_reply_code $(<reply>rr)","acc");
+acc_db_request("$T_reply_code $(<reply>rr)", "acc");
 ...
 
 1.8.5.  acc_aaa_request(comment)
@@ -820,10 +820,10 @@ acc_db_request("$T_reply_code $(<reply>rr)","acc");
    reports to aaa server as configured in “aaa_url”.
 
    Meaning of the parameters is as follows:
-     * comment - Comment describing how the request completed -
-       this string has to contain a reply code followed by a reply
-       reason phrase (ex: "404 Nobody home"). Variables are
-       accepted in this string.
+     * comment (string) - Comment describing how the request
+       completed - this string has to contain a reply code
+       followed by a reply reason phrase (ex: "404 Nobody home").
+       Variables are accepted in this string.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and LOCAL_ROUTE.
@@ -842,10 +842,9 @@ acc_aaa_request("403 Destination not allowed");
    codes. More information on this in Exported Events.
 
    Meaning of the parameters is as follows:
-     * comment - Comment describing how the request completed -
-       this string has to contain a reply code followed by a reply
-       reason phrase (ex: "404 Nobody home"). Variables are
-       accepted in this string.
+     * comment (string) - Comment describing how the request
+       completed - this string has to contain a reply code
+       followed by a reply reason phrase (ex: "404 Nobody home")
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and LOCAL_ROUTE.
@@ -1021,7 +1020,7 @@ Chapter 3. Contributors
    3. Ionut Ionita (@ionutrazvanionita) 144 39 3730 4180
    4. Razvan Crainea (@razvancrainea) 85 54 2588 523
    5. Jiri Kuthan (@jiriatipteldotorg) 56 26 2272 660
-   6. Liviu Chircu (@liviuchircu) 53 38 518 504
+   6. Liviu Chircu (@liviuchircu) 54 39 534 521
    7. Daniel-Constantin Mierla (@miconda) 26 23 115 88
    8. Elena-Ramona Modroiu 23 4 2267 5
    9. Henning Westerholt (@henningw) 20 15 184 131
@@ -1057,9 +1056,9 @@ Chapter 3. Contributors
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
    1.  Razvan Crainea (@razvancrainea)     Aug 2010 - Jul 2019
-   2.  Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Apr 2019
-   3.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
-   4.  Liviu Chircu (@liviuchircu)         Jan 2013 - Nov 2018
+   2.  Liviu Chircu (@liviuchircu)         Jan 2013 - Apr 2019
+   3.  Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Apr 2019
+   4.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
    5.  Dan Pascu (@danpascu)               Jul 2004 - Sep 2018
    6.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
    7.  Ionut Ionita (@ionutrazvanionita)   Feb 2015 - May 2017

diff --git a/modules/acc/doc/contributors.xml b/modules/acc/doc/contributors.xml
@@ -61,10 +61,10 @@
 	<row>
 		<entry>6. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">53</entry>
-		<entry align="center">38</entry>
-		<entry align="center">518</entry>
-		<entry align="center">504</entry>
+		<entry align="center">54</entry>
+		<entry align="center">39</entry>
+		<entry align="center">534</entry>
+		<entry align="center">521</entry>
 	</row>
 	<row>
 		<entry>7. </entry>
@@ -133,18 +133,18 @@
 	</row>
 	<row>
 		<entry>2. </entry>
-		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">Dec 2003 - Apr 2019</entry>
+		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
+		<entry align="center">Jan 2013 - Apr 2019</entry>
 	</row>
 	<row>
 		<entry>3. </entry>
-		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
-		<entry align="center">May 2017 - Apr 2019</entry>
+		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
+		<entry align="center">Dec 2003 - Apr 2019</entry>
 	</row>
 	<row>
 		<entry>4. </entry>
-		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">Jan 2013 - Nov 2018</entry>
+		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
+		<entry align="center">May 2017 - Apr 2019</entry>
 	</row>
 	<row>
 		<entry>5. </entry>

diff --git a/modules/alias_db/README b/modules/alias_db/README
@@ -23,9 +23,9 @@ ALIAS_DB Module
 
         1.4. Exported Functions
 
-              1.4.1. alias_db_lookup( table_name [,flags] )
-              1.4.2. alias_db_find( table_name , input, output
-                      [,flags] )
+              1.4.1. alias_db_lookup(table_name, [flags])
+              1.4.2. alias_db_find(table_name, input_uri,
+                      output_var, [flags])
 
    2. Frequently Asked Questions
    3. Contributors
@@ -169,7 +169,7 @@ modparam("alias_db", "append_branches", 1)
 
 1.4. Exported Functions
 
-1.4.1.  alias_db_lookup( table_name [,flags] )
+1.4.1.  alias_db_lookup(table_name, [flags])
 
    The function takes the R-URI and search to see whether it is an
    alias or not. If it is an alias for a local user, the R-URI is
@@ -179,14 +179,14 @@ modparam("alias_db", "append_branches", 1)
    by user's SIP uri.
 
    Meaning of the parameters is as follows:
-     * table_name - any PV (string or PV or mix) the name of the
-       table where to search for alias.
-     * flags (optional) - set of flags (char based flags) to
+     * table_name (string) - the name of the table to search for
+       the alias
+     * flags (string, optional) - set of character flags to
        control the alias lookup process:
           + d - do not use domain URI part in the alias lookup
             query (use only a username-based lookup). By default,
             both username and domain are used.
-          + r - do revers alias lookup - lookup for the alias
+          + r - do reverse alias lookup - lookup for the alias
             mapped to the current URI (URI 2 alias translation);
             normally, the function looks up for the URI mapped to
             the alias (alias 2 URI translation).
@@ -195,11 +195,11 @@ modparam("alias_db", "append_branches", 1)
 
    Example 1.8. alias_db_lookup() usage
 ...
-alias_db_lookup("dbaliases" , "rd");
+alias_db_lookup("dbaliases", "rd");
 alias_db_lookup("dba_$(rU{s.substr,0,1})");
 ...
 
-1.4.2.  alias_db_find( table_name , input, output [,flags] )
+1.4.2.  alias_db_find(table_name, input_uri, output_var, [flags])
 
    The function is very similar to alias_db_lookup(), but instead
    of using fixed input (RURI) and output (RURI) is able to get
@@ -215,14 +215,12 @@ alias_db_lookup("dba_$(rU{s.substr,0,1})");
    returned.
 
    Meaning of the parameters is as follows:
-     * table_name - any PV (string or PV or mix) the name of the
-       table where to search for alias.
-     * input - any PV (string or PV or mix) carrying the SIP URI
-       that needs to be looked up.
-     * output - PV (AVP or script VAR) where to place the SIP URI
-       resulting from the alias lookup.
-     * flags (optional) - set of flags (char based flags) to
-       control the alias lookup process:
+     * table_name (string) - the name of the table to search for
+       the alias
+     * input_uri (string) - a SIP URI to look up
+     * output_var (var) - a variable to hold the SIP URI result
+     * flags (string, optional) (optional) - set of flags (char
+       based flags) to control the alias lookup process:
           + d - do not use domain URI part in the alias lookup
             query (use only a username-based lookup). By default,
             both username and domain are used.
@@ -237,7 +235,7 @@ alias_db_lookup("dba_$(rU{s.substr,0,1})");
    Example 1.9. alias_db_find() usage
 ...
 # do revers alias lookup and find the alias for the FROM URI
-alias_db_find("dbaliases" , "$fu", "$avp(from_alias)", "r");
+alias_db_find("dbaliases", $fu, $avp(from_alias), "r");
 ...
 
 Chapter 2. Frequently Asked Questions
@@ -267,7 +265,7 @@ Chapter 3. Contributors
      Name DevScore Commits Lines ++ Lines --
    1. Bogdan-Andrei Iancu (@bogdan-iancu) 31 26 216 166
    2. Daniel-Constantin Mierla (@miconda) 15 12 28 64
-   3. Liviu Chircu (@liviuchircu) 10 8 32 45
+   3. Liviu Chircu (@liviuchircu) 12 9 48 62
    4. Henning Westerholt (@henningw) 6 4 48 49
    5. Razvan Crainea (@razvancrainea) 6 4 8 7
    6. Elena-Ramona Modroiu 5 3 92 39
@@ -301,10 +299,10 @@ Chapter 3. Contributors
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
    1.  Razvan Crainea (@razvancrainea)     Jun 2011 - May 2019
-   2.  Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2005 - Apr 2019
-   3.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
-   4.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
-   5.  Liviu Chircu (@liviuchircu)         Mar 2014 - Jun 2018
+   2.  Liviu Chircu (@liviuchircu)         Mar 2014 - Apr 2019
+   3.  Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2005 - Apr 2019
+   4.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
+   5.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
    6.  Dusan Klinec                        Dec 2015 - Dec 2015
    7.  Sergey Khripchenko                  Sep 2015 - Sep 2015
    8.  Walter Doekes (@wdoekes)            Apr 2010 - Apr 2010
@@ -322,8 +320,8 @@ Chapter 4. Documentation
 
 4.1. Contributors
 
-   Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
-   (@liviuchircu), Sergey Khripchenko, Razvan Crainea
+   Last edited by: Liviu Chircu (@liviuchircu), Peter Lemenkov
+   (@lemenkov), Sergey Khripchenko, Razvan Crainea
    (@razvancrainea), Walter Doekes (@wdoekes), Bogdan-Andrei Iancu
    (@bogdan-iancu), Sergio Gutierrez, Henning Westerholt
    (@henningw), Elena-Ramona Modroiu, Daniel-Constantin Mierla

diff --git a/modules/alias_db/doc/contributors.xml b/modules/alias_db/doc/contributors.xml
@@ -37,10 +37,10 @@
 	<row>
 		<entry>3. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">10</entry>
-		<entry align="center">8</entry>
-		<entry align="center">32</entry>
-		<entry align="center">45</entry>
+		<entry align="center">12</entry>
+		<entry align="center">9</entry>
+		<entry align="center">48</entry>
+		<entry align="center">62</entry>
 	</row>
 	<row>
 		<entry>4. </entry>
@@ -133,24 +133,24 @@
 	</row>
 	<row>
 		<entry>2. </entry>
+		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
+		<entry align="center">Mar 2014 - Apr 2019</entry>
+	</row>
+	<row>
+		<entry>3. </entry>
 		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
 		<entry align="center">Oct 2005 - Apr 2019</entry>
 	</row>
 	<row>
-		<entry>3. </entry>
+		<entry>4. </entry>
 		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
 		<entry align="center">May 2017 - Apr 2019</entry>
 	</row>
 	<row>
-		<entry>4. </entry>
+		<entry>5. </entry>
 		<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
 		<entry align="center">Jun 2018 - Jun 2018</entry>
 	</row>
-	<row>
-		<entry>5. </entry>
-		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">Mar 2014 - Jun 2018</entry>
-	</row>
 	<row>
 		<entry>6. </entry>
 		<entry>Dusan Klinec</entry>
@@ -190,7 +190,7 @@
 	<title>Documentation</title>
 <section id="documentation_contributors" xreflabel="documentation_contributors">
 	<title>Contributors</title>
-	<para><emphasis role='bold'>Last edited by:</emphasis> Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Sergey Khripchenko, Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Sergio Gutierrez, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Elena-Ramona Modroiu, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert.</para>
+	<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Sergey Khripchenko, Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Sergio Gutierrez, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Elena-Ramona Modroiu, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert.</para>
 </section>
 
 </chapter>