Rebuild documentation

OpenSIPS · Apr 28, 2019 · 6e33781 · 6e33781
1 parent 5c7dd8a
commit 6e33781
Show file tree

Hide file tree

Showing 170 changed files with 3,695 additions and 3,838 deletions.
diff --git a/modules/aaa_radius/README b/modules/aaa_radius/README
@@ -214,14 +214,14 @@ modparam("aaa_radius", "fetch_all_values", 1)
    This function can be used from the script to make custom radius
    authentication request. The function takes two parameters.
 
-   The first parameter represents the name of the set that
-   contains the list of attributes and pvars that will form the
-   authentication request (see the “sets” module parameter).
-
-   The second parameter represents the name of the set that
-   contains the list of attributes and pvars that will be
-   extracted form the authentication reply (see the “sets” module
-   parameter).
+   Parameters:
+     * input_set_name (string) - the name of the set that contains
+       the list of attributes and pvars that will form the
+       authentication request (see the “sets” module parameter).
+     * output_set_name (string) - the name of the set that
+       contains the list of attributes and pvars that will be
+       extracted form the authentication reply (see the “sets”
+       module parameter).
 
    The sets must be defined using the “sets” exported parameter.
 
@@ -254,9 +254,10 @@ switch ($rc) {
 1.4.2.  radius_send_acct(input_set_name)
 
    This function can be used from the script to make custom radius
-   authentication request. The function takes only one parameter
-   that represents the name of the set that contains the list of
-   attributes and pvars that will form the accounting request.
+   authentication request. The function takes only one string
+   parameter that represents the name of the set that contains the
+   list of attributes and pvars that will form the accounting
+   request.
 
    Only one set is needed as a parameter because no AVPs can be
    extracted from the accounting replies.
@@ -278,16 +279,16 @@ radius_send_acct("set1");
 1.5.1.  radius_send_auth(input_set_name, output_set_name)
 
    This function can be used from the script to make custom radius
-   authentication request. The function takes two parameters.
-
-   The first parameter represents the name of the set that
-   contains the list of attributes and pvars that will form the
-   authentication request (see the “sets” module parameter).
+   authentication request.
 
-   The second parameter represents the name of the set that
-   contains the list of attributes and pvars that will be
-   extracted form the authentication reply (see the “sets” module
-   parameter).
+   Parameters:
+     * input_set_name (string) - the name of the set that contains
+       the list of attributes and pvars that will form the
+       authentication request (see the “sets” module parameter).
+     * output_set_name (string) - the name of the set that
+       contains the list of attributes and pvars that will be
+       extracted form the authentication reply (see the “sets”
+       module parameter).
 
    The sets must be defined using the “sets” exported parameter.
 
@@ -321,9 +322,10 @@ switch ($rc) {
 1.5.2.  radius_send_acct(input_set_name)
 
    This function can be used from the script to make custom radius
-   authentication request. The function takes only one parameter
-   that represents the name of the set that contains the list of
-   attributes and pvars that will form the accounting request.
+   authentication request. The function takes only one string
+   parameter that represents the name of the set that contains the
+   list of attributes and pvars that will form the accounting
+   request.
 
    Only one set is needed as a parameter because no AVPs can be
    extracted from the accounting replies.
@@ -396,8 +398,8 @@ Chapter 3. Contributors
    3. Bogdan-Andrei Iancu (@bogdan-iancu) 15 12 102 82
    4. Razvan Crainea (@razvancrainea) 12 10 48 41
    5. Liviu Chircu (@liviuchircu) 9 7 21 49
-   6. Boris Ratner 4 2 38 5
-   7. Vlad Patrascu (@rvlad-patrascu) 4 2 16 48
+   6. Vlad Patrascu (@rvlad-patrascu) 6 3 49 73
+   7. Boris Ratner 4 2 38 5
    8. Anca Vamanu 4 2 5 3
    9. Matt Lehner 3 1 32 3
    10. Авдиенко Михаил 3 1 7 17
@@ -425,8 +427,8 @@ Chapter 3. Contributors
 
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2019
-   2.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
+   1.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
+   2.  Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2019
    3.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
    4.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
    5.  Ionut Ionita (@ionutrazvanionita)   Jun 2015 - Apr 2017
@@ -446,10 +448,11 @@ Chapter 4. Documentation
 
 4.1. Contributors
 
-   Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
-   (@liviuchircu), Razvan Crainea (@razvancrainea), Ionut Ionita
-   (@ionutrazvanionita), Walter Doekes (@wdoekes), Bogdan-Andrei
-   Iancu (@bogdan-iancu), Boris Ratner, Irina-Maria Stanescu.
+   Last edited by: Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov
+   (@lemenkov), Liviu Chircu (@liviuchircu), Razvan Crainea
+   (@razvancrainea), Ionut Ionita (@ionutrazvanionita), Walter
+   Doekes (@wdoekes), Bogdan-Andrei Iancu (@bogdan-iancu), Boris
+   Ratner, Irina-Maria Stanescu.
 
    Documentation Copyrights:
 

diff --git a/modules/aaa_radius/doc/contributors.xml b/modules/aaa_radius/doc/contributors.xml
@@ -60,19 +60,19 @@
 	</row>
 	<row>
 		<entry>6. </entry>
-		<entry>Boris Ratner</entry>
-		<entry align="center">4</entry>
-		<entry align="center">2</entry>
-		<entry align="center">38</entry>
-		<entry align="center">5</entry>
+		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
+		<entry align="center">6</entry>
+		<entry align="center">3</entry>
+		<entry align="center">49</entry>
+		<entry align="center">73</entry>
 	</row>
 	<row>
 		<entry>7. </entry>
-		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
+		<entry>Boris Ratner</entry>
 		<entry align="center">4</entry>
 		<entry align="center">2</entry>
-		<entry align="center">16</entry>
-		<entry align="center">48</entry>
+		<entry align="center">38</entry>
+		<entry align="center">5</entry>
 	</row>
 	<row>
 		<entry>8. </entry>
@@ -128,13 +128,13 @@
 	<tbody>
 	<row>
 		<entry>1. </entry>
-		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">Aug 2009 - Apr 2019</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>2. </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">Aug 2009 - Apr 2019</entry>
 	</row>
 	<row>
 		<entry>3. </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>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Boris Ratner, Irina-Maria Stanescu.</para>
+	<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Boris Ratner, Irina-Maria Stanescu.</para>
 </section>
 
 </chapter>
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) 79 50 2473 448
    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
@@ -1056,9 +1055,9 @@ Chapter 3. Contributors
 
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Apr 2019
-   2.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
-   3.  Liviu Chircu (@liviuchircu)         Jan 2013 - Nov 2018
+   1.  Liviu Chircu (@liviuchircu)         Jan 2013 - Apr 2019
+   2.  Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Apr 2019
+   3.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
    4.  Razvan Crainea (@razvancrainea)     Aug 2010 - Oct 2018
    5.  Dan Pascu (@danpascu)               Jul 2004 - Sep 2018
    6.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018

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>
@@ -128,18 +128,18 @@
 	<tbody>
 	<row>
 		<entry>1. </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>2. </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>3. </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>4. </entry>