Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Jan 28, 2023
1 parent 7261057 commit af671fd
Show file tree
Hide file tree
Showing 8 changed files with 71 additions and 57 deletions.
10 changes: 5 additions & 5 deletions modules/auth/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -521,9 +521,9 @@ Chapter 2. Contributors
1. Jan Janak (@janakj) 269 107 7717 6060
2. Bogdan-Andrei Iancu (@bogdan-iancu) 51 34 704 615
3. Daniel-Constantin Mierla (@miconda) 39 21 1136 476
4. Jiri Kuthan (@jiriatipteldotorg) 26 19 660 51
5. Liviu Chircu (@liviuchircu) 26 19 199 284
6. Maksym Sobolyev (@sobomax) 26 7 516 813
4. Maksym Sobolyev (@sobomax) 27 8 524 813
5. Jiri Kuthan (@jiriatipteldotorg) 26 19 660 51
6. Liviu Chircu (@liviuchircu) 26 19 199 284
7. Vlad Patrascu (@rvlad-patrascu) 13 7 193 210
8. Razvan Crainea (@razvancrainea) 12 9 87 102
9. Anca Vamanu 12 5 497 77
Expand Down Expand Up @@ -556,8 +556,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2014 - Aug 2022
2. Maksym Sobolyev (@sobomax) Jan 2005 - Sep 2021
1. Maksym Sobolyev (@sobomax) Jan 2005 - Jan 2023
2. Liviu Chircu (@liviuchircu) Mar 2014 - Aug 2022
3. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2002 - Jan 2021
4. Zero King (@l2dy) Mar 2020 - Mar 2020
5. Razvan Crainea (@razvancrainea) Jun 2011 - Sep 2019
Expand Down
26 changes: 13 additions & 13 deletions modules/auth/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,28 +44,28 @@
</row>
<row>
<entry>4. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">27</entry>
<entry align="center">8</entry>
<entry align="center">524</entry>
<entry align="center">813</entry>
</row>
<row>
<entry>5. </entry>
<entry>Jiri Kuthan (<ulink url="https://github.com/jiriatipteldotorg">@jiriatipteldotorg</ulink>)</entry>
<entry align="center">26</entry>
<entry align="center">19</entry>
<entry align="center">660</entry>
<entry align="center">51</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">26</entry>
<entry align="center">19</entry>
<entry align="center">199</entry>
<entry align="center">284</entry>
</row>
<row>
<entry>6. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">26</entry>
<entry align="center">7</entry>
<entry align="center">516</entry>
<entry align="center">813</entry>
</row>
<row>
<entry>7. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Aug 2022</entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2005 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2005 - Sep 2021</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Aug 2022</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
8 changes: 4 additions & 4 deletions modules/dialog/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2488,7 +2488,7 @@ Chapter 4. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 440 279 12848 3428
2. Razvan Crainea (@razvancrainea) 258 194 4882 1462
2. Razvan Crainea (@razvancrainea) 259 195 4886 1464
3. Vlad Paiu (@vladpaiu) 253 144 7205 3026
4. Vlad Patrascu (@rvlad-patrascu) 184 98 3830 3265
5. Liviu Chircu (@liviuchircu) 164 119 2880 1230
Expand Down Expand Up @@ -2532,9 +2532,9 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Aug 2012 - Jan 2023
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Nov 2022
3. Razvan Crainea (@razvancrainea) Aug 2010 - Oct 2022
1. Razvan Crainea (@razvancrainea) Aug 2010 - Jan 2023
2. Liviu Chircu (@liviuchircu) Aug 2012 - Jan 2023
3. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Nov 2022
4. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2022
5. Vlad Paiu (@vladpaiu) Oct 2010 - Nov 2021
6. Nick Altmann (@nikbyte) Oct 2013 - May 2021
Expand Down
20 changes: 10 additions & 10 deletions modules/dialog/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">258</entry>
<entry align="center">194</entry>
<entry align="center">4882</entry>
<entry align="center">1462</entry>
<entry align="center">259</entry>
<entry align="center">195</entry>
<entry align="center">4886</entry>
<entry align="center">1464</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,18 +128,18 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Jan 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Apr 2006 - Nov 2022</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Jan 2023</entry>
</row>
<row>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Oct 2022</entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Apr 2006 - Nov 2022</entry>
</row>
<row>
<entry>4. </entry>
Expand Down
26 changes: 20 additions & 6 deletions modules/mi_script/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ MI script Module
1.6. mi with return
1.7. mi without return but with indexed params
1.8. mi with return and named parameters
1.9. async mi call usage
1.9. mi without return, with an array parameter value
1.10. async mi call usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -203,6 +204,9 @@ modparam("mi_stream", "trace_bwlist", "w: sip_trace")
parameter only makes sense if the params_avp is set, and
has to contain the same number of values as there are
parameters.
To specify array values, enclose your space-separated array
elements in the __array() pseudo-function call. For
example: "__array(HEARTBEAT BACKGROUND_JOB)"

Example 1.4. mi without params
...
Expand Down Expand Up @@ -237,6 +241,15 @@ $avp(vals) = "SEARCH_FOR_THIS_CALLID";
$avp(params) = "from_tag";
$avp(vals) = "SEARCH_FOR_THIS_FROM_TAG";
mi("dlg_list", $var(dlg), $avp(params), $avp(vals));
...

Example 1.9. mi without return, with an array parameter value
...
$avp(params) = "freeswitch_url";
$avp(vals) = "fs://:ClueCon@192.168.20.8:8021";
$avp(params) = "events";
$avp(vals) = "__array(HEARTBEAT BACKGROUND_JOB)";
mi("fs_subscribe", , $avp(params), $avp(vals));
...

1.6. Exported Asyncronous Functions
Expand All @@ -252,7 +265,7 @@ mi("dlg_list", $var(dlg), $avp(params), $avp(vals));
NOTE: currently MI commands run asynchronously cannot be traced
through hep.

Example 1.9. async mi call usage
Example 1.10. async mi call usage
...
xlog("reload starting\n");
async(mi("dr_reload"), after_reload);
Expand All @@ -270,7 +283,7 @@ Chapter 2. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Razvan Crainea (@razvancrainea) 17 6 1112 13
2. Liviu Chircu (@liviuchircu) 3 1 7 2
2. Liviu Chircu (@liviuchircu) 4 2 61 5

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -292,8 +305,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) May 2021 - Sep 2022
2. Liviu Chircu (@liviuchircu) Jun 2022 - Jun 2022
1. Liviu Chircu (@liviuchircu) Jun 2022 - Jan 2023
2. Razvan Crainea (@razvancrainea) May 2021 - Sep 2022

(1) including any documentation-related commits, excluding
merge commits
Expand All @@ -302,7 +315,8 @@ Chapter 3. Documentation

3.1. Contributors

Last edited by: Razvan Crainea (@razvancrainea).
Last edited by: Liviu Chircu (@liviuchircu), Razvan Crainea
(@razvancrainea).

Documentation Copyrights:

Expand Down
16 changes: 8 additions & 8 deletions modules/mi_script/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
<entry align="center">7</entry>
<entry align="center">4</entry>
<entry align="center">2</entry>
<entry align="center">61</entry>
<entry align="center">5</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -64,13 +64,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">May 2021 - Sep 2022</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jun 2022 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jun 2022 - Jun 2022</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">May 2021 - Sep 2022</entry>
</row>
</tbody>
</tgroup>
Expand All @@ -86,7 +86,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>).</para>
</section>

</chapter>
6 changes: 3 additions & 3 deletions modules/tm/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1586,7 +1586,7 @@ Chapter 4. Contributors
2. Jiri Kuthan (@jiriatipteldotorg) 534 198 18723 11167
3. Jan Janak (@janakj) 160 76 6462 1840
4. Andrei Pelinescu-Onciul 145 105 2447 1210
5. Razvan Crainea (@razvancrainea) 121 93 1773 763
5. Razvan Crainea (@razvancrainea) 122 94 1776 764
6. Liviu Chircu (@liviuchircu) 105 79 1232 874
7. Daniel-Constantin Mierla (@miconda) 43 37 322 166
8. Anca Vamanu 37 19 778 651
Expand Down Expand Up @@ -1629,8 +1629,8 @@ Chapter 4. Contributors
Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Nov 2001 - Jan 2023
2. Liviu Chircu (@liviuchircu) Jan 2013 - Oct 2022
3. Razvan Crainea (@razvancrainea) Jul 2010 - Apr 2022
2. Razvan Crainea (@razvancrainea) Jul 2010 - Jan 2023
3. Liviu Chircu (@liviuchircu) Jan 2013 - Oct 2022
4. Maksym Sobolyev (@sobomax) Mar 2004 - Mar 2021
5. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2021
6. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2020
Expand Down
16 changes: 8 additions & 8 deletions modules/tm/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">121</entry>
<entry align="center">93</entry>
<entry align="center">1773</entry>
<entry align="center">763</entry>
<entry align="center">122</entry>
<entry align="center">94</entry>
<entry align="center">1776</entry>
<entry align="center">764</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -133,13 +133,13 @@
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Oct 2022</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jul 2010 - Jan 2023</entry>
</row>
<row>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jul 2010 - Apr 2022</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Oct 2022</entry>
</row>
<row>
<entry>4. </entry>
Expand Down

0 comments on commit af671fd

Please sign in to comment.