Skip to content

Commit 8384cb0

Browse files
opensips-githubopensips-github
committed
Rebuild documentation
1 parent e046335 commit 8384cb0

File tree

10 files changed

+195
-82
lines changed

10 files changed

+195
-82
lines changed

‎modules/janus/README‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Chapter 1. Admin Guide
7272
closed if it is not available for blocking writing in this
7373
interval (and OpenSIPS wants to send something on it).
7474

75-
Default value is "1000" (milliseconds).
75+
Default value is “1000” (milliseconds).
7676

7777
Example 1.1. Setting the janus_send_timeout parameter
7878
...
@@ -85,7 +85,7 @@ modparam("janus", "janus_send_timeout", 2000)
8585
expected to arrive via WebSocket. If a received packet is more
8686
fragmented than this, the connection is dropped
8787

88-
Default value is "4"
88+
Default value is “4”
8989

9090
Example 1.2. Setting the janus_max_msg_chunks parameter
9191
...
@@ -97,7 +97,7 @@ modparam("janus", "janus_max_msg_chunks", 8)
9797
The maximally allowed duration for the execution of an Janus
9898
command. This interval does not include the connect duration.
9999

100-
Default value is "5000" (milliseconds).
100+
Default value is “5000” (milliseconds).
101101

102102
Example 1.3. Setting the janus_cmd_timeout parameter
103103
...
@@ -113,7 +113,7 @@ modparam("janus", "janus_cmd_timeout", 3000)
113113
time for an arbitrary Janus command, then tune this parameter
114114
accordingly.
115115

116-
Default value is "1000" (microseconds).
116+
Default value is “1000” (microseconds).
117117

118118
Example 1.4. Setting the janus_cmd_polling_itv parameter
119119
...
@@ -125,7 +125,7 @@ modparam("janus", "janus_cmd_polling_itv", 3000)
125125
The time interval at which OpenSIPS will do keepalive pinging
126126
on the Janus connect
127127

128-
Default value is "5" (seconds).
128+
Default value is “5” (seconds).
129129

130130
Example 1.5. Setting the janus_ping_interval parameter
131131
...
@@ -137,7 +137,7 @@ modparam("janus", "janus_ping_interval", 10)
137137
The DB URL from where OpenSIPS will load the list of Janus
138138
connection
139139

140-
Default value is ""none"" (needs to be set for the module to
140+
Default value is “"none"” (needs to be set for the module to
141141
start).
142142

143143
Example 1.6. Setting the janus_db_url parameter
@@ -150,7 +150,7 @@ modparam("janus", "janus_db_url", "mysql://root@localhost/opensips")
150150
The DB Table from where OpenSIPS will load the list of Janus
151151
connection
152152

153-
Default value is "janus"
153+
Default value is “janus”
154154

155155
Example 1.7. Setting the janus_db_table parameter
156156
...
@@ -243,4 +243,4 @@ url) - $param(janus_body) \n");
243243

244244
Documentation Copyrights:
245245

246-
Copyright � 2024 OpenSIPS Project;
246+
Copyright © 2024 OpenSIPS Project;

‎modules/janus/doc/contributors.xml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!-- THIS IS AN AUTO-GENERATED FILE -->
2+
<chapter id="contributors" xreflabel="contributors">
3+
<title>&contributors;</title>
4+
5+
<section id="contrib_commit_statistics" xreflabel="contrib_commit_statistics">
6+
<title>By Commit Statistics</title>
7+
8+
<table frame='all'><title>Top contributors by DevScore<superscript>(1)</superscript>, authored commits<superscript>(2)</superscript> and lines added/removed<superscript>(3)</superscript></title>
9+
<tgroup cols='6' align='left' colsep='1' rowsep='1'>
10+
<thead>
11+
<row>
12+
<entry align="center"></entry>
13+
<entry align="center">Name</entry>
14+
<entry align="center">DevScore</entry>
15+
<entry align="center">Commits</entry>
16+
<entry align="center">Lines ++</entry>
17+
<entry align="center">Lines --</entry>
18+
</row>
19+
</thead>
20+
<tbody>
21+
<row>
22+
<entry>1. </entry>
23+
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
24+
<entry align="center">42</entry>
25+
<entry align="center">4</entry>
26+
<entry align="center">4387</entry>
27+
<entry align="center">4</entry>
28+
</row>
29+
</tbody>
30+
</tgroup>
31+
</table>
32+
33+
<para>
34+
<emphasis>(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)</emphasis>
35+
</para>
36+
<para>
37+
<emphasis>(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please <ulink url="https://github.com/OpenSIPS/opensips/pulls"><citetitle>submit a pull request</citetitle></ulink></emphasis> which extends "fix_authors" and/or "mod_renames".
38+
</para>
39+
<para>
40+
<emphasis>(3) ignoring whitespace edits, renamed files and auto-generated files</emphasis>
41+
</para>
42+
</section>
43+
44+
<section id="contrib_commit_activity" xreflabel="contrib_commit_activity">
45+
<title>By Commit Activity</title>
46+
47+
<table frame='all'><title>Most recently active contributors<superscript>(1)</superscript> to this module</title>
48+
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
49+
<thead>
50+
<row>
51+
<entry align="center"></entry>
52+
<entry align="center">Name</entry>
53+
<entry align="center">Commit Activity</entry>
54+
</row>
55+
</thead>
56+
<tbody>
57+
<row>
58+
<entry>1. </entry>
59+
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
60+
<entry align="center">Dec 2024 - Feb 2025</entry>
61+
</row>
62+
</tbody>
63+
</tgroup>
64+
</table>
65+
66+
<para>
67+
<emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
68+
</para>
69+
</section>
70+
71+
</chapter>
72+
<chapter id="documentation" xreflabel="documentation">
73+
<title>Documentation</title>
74+
<section id="documentation_contributors" xreflabel="documentation_contributors">
75+
<title>Contributors</title>
76+
<para><emphasis role='bold'>Last edited by:</emphasis> Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>).</para>
77+
</section>
78+
79+
</chapter>

‎modules/mqueue/README‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,12 @@ opensips-cli -x mq_get_size xyz
220220

221221
1.5.2. mq_fetch
222222

223-
Fetch a key-value pair from a memory queue.
223+
Fetch one (or up to limit) key-value pair from a memory queue.
224224

225225
Parameters:
226226
* name - the name of memory queue
227+
* limit (optional) - if used, an array with up to limit
228+
records are being returned.
227229

228230
Example 1.8. mq_fetch usage
229231
...
@@ -264,9 +266,10 @@ Chapter 2. Contributors
264266

265267
Table 2.1. Top contributors by DevScore^(1), authored
266268
commits^(2) and lines added/removed^(3)
267-
Name DevScore Commits Lines ++ Lines --
268-
1. Ovidiu Sas (@ovidiusas) 19 2 1843 34
269-
2. Alexandra Titoc 3 1 13 9
269+
Name DevScore Commits Lines ++ Lines --
270+
1. Ovidiu Sas (@ovidiusas) 19 2 1843 34
271+
2. Razvan Crainea (@razvancrainea) 3 1 75 16
272+
3. Alexandra Titoc 3 1 13 9
270273

271274
(1) DevScore = author_commits + author_lines_added /
272275
(project_lines_added / project_commits) + author_lines_deleted
@@ -287,9 +290,10 @@ Chapter 2. Contributors
287290
2.2. By Commit Activity
288291

289292
Table 2.2. Most recently active contributors^(1) to this module
290-
Name Commit Activity
291-
1. Alexandra Titoc Sep 2024 - Sep 2024
292-
2. Ovidiu Sas (@ovidiusas) Feb 2024 - Feb 2024
293+
Name Commit Activity
294+
1. Razvan Crainea (@razvancrainea) Feb 2025 - Feb 2025
295+
2. Alexandra Titoc Sep 2024 - Sep 2024
296+
3. Ovidiu Sas (@ovidiusas) Feb 2024 - Feb 2024
293297

294298
(1) including any documentation-related commits, excluding
295299
merge commits
@@ -298,7 +302,8 @@ Chapter 3. Documentation
298302

299303
3.1. Contributors
300304

301-
Last edited by: Ovidiu Sas (@ovidiusas).
305+
Last edited by: Razvan Crainea (@razvancrainea), Ovidiu Sas
306+
(@ovidiusas).
302307

303308
Documentation Copyrights:
304309

‎modules/mqueue/doc/contributors.xml‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@
2828
</row>
2929
<row>
3030
<entry>2. </entry>
31+
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
32+
<entry align="center">3</entry>
33+
<entry align="center">1</entry>
34+
<entry align="center">75</entry>
35+
<entry align="center">16</entry>
36+
</row>
37+
<row>
38+
<entry>3. </entry>
3139
<entry>Alexandra Titoc</entry>
3240
<entry align="center">3</entry>
3341
<entry align="center">1</entry>
@@ -64,11 +72,16 @@
6472
<tbody>
6573
<row>
6674
<entry>1. </entry>
75+
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
76+
<entry align="center">Feb 2025 - Feb 2025</entry>
77+
</row>
78+
<row>
79+
<entry>2. </entry>
6780
<entry>Alexandra Titoc</entry>
6881
<entry align="center">Sep 2024 - Sep 2024</entry>
6982
</row>
7083
<row>
71-
<entry>2. </entry>
84+
<entry>3. </entry>
7285
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
7386
<entry align="center">Feb 2024 - Feb 2024</entry>
7487
</row>
@@ -86,7 +99,7 @@
8699
<title>Documentation</title>
87100
<section id="documentation_contributors" xreflabel="documentation_contributors">
88101
<title>Contributors</title>
89-
<para><emphasis role='bold'>Last edited by:</emphasis> Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>).</para>
102+
<para><emphasis role='bold'>Last edited by:</emphasis> Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>).</para>
90103
</section>
91104

92105
</chapter>

‎modules/pua_reginfo/README‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,8 @@ Chapter 2. Contributors
275275
1. Carsten Bock 18 1 1930 0
276276
2. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 16 19
277277
3. Liviu Chircu (@liviuchircu) 3 1 2 3
278-
4. Razvan Crainea (@razvancrainea) 2 1 1 0
278+
4. Peter Lemenkov (@lemenkov) 3 1 1 1
279+
5. Razvan Crainea (@razvancrainea) 2 1 1 0
279280

280281
(1) DevScore = author_commits + author_lines_added /
281282
(project_lines_added / project_commits) + author_lines_deleted
@@ -297,10 +298,11 @@ Chapter 2. Contributors
297298

298299
Table 2.2. Most recently active contributors^(1) to this module
299300
Name Commit Activity
300-
1. Razvan Crainea (@razvancrainea) Jan 2025 - Jan 2025
301-
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2024 - Apr 2024
302-
3. Liviu Chircu (@liviuchircu) Apr 2024 - Apr 2024
303-
4. Carsten Bock Mar 2024 - Mar 2024
301+
1. Peter Lemenkov (@lemenkov) Feb 2025 - Feb 2025
302+
2. Razvan Crainea (@razvancrainea) Jan 2025 - Jan 2025
303+
3. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2024 - Apr 2024
304+
4. Liviu Chircu (@liviuchircu) Apr 2024 - Apr 2024
305+
5. Carsten Bock Mar 2024 - Mar 2024
304306

305307
(1) including any documentation-related commits, excluding
306308
merge commits

‎modules/pua_reginfo/doc/contributors.xml‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@
4444
</row>
4545
<row>
4646
<entry>4. </entry>
47+
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
48+
<entry align="center">3</entry>
49+
<entry align="center">1</entry>
50+
<entry align="center">1</entry>
51+
<entry align="center">1</entry>
52+
</row>
53+
<row>
54+
<entry>5. </entry>
4755
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
4856
<entry align="center">2</entry>
4957
<entry align="center">1</entry>
@@ -80,21 +88,26 @@
8088
<tbody>
8189
<row>
8290
<entry>1. </entry>
91+
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
92+
<entry align="center">Feb 2025 - Feb 2025</entry>
93+
</row>
94+
<row>
95+
<entry>2. </entry>
8396
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
8497
<entry align="center">Jan 2025 - Jan 2025</entry>
8598
</row>
8699
<row>
87-
<entry>2. </entry>
100+
<entry>3. </entry>
88101
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
89102
<entry align="center">Apr 2024 - Apr 2024</entry>
90103
</row>
91104
<row>
92-
<entry>3. </entry>
105+
<entry>4. </entry>
93106
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
94107
<entry align="center">Apr 2024 - Apr 2024</entry>
95108
</row>
96109
<row>
97-
<entry>4. </entry>
110+
<entry>5. </entry>
98111
<entry>Carsten Bock</entry>
99112
<entry align="center">Mar 2024 - Mar 2024</entry>
100113
</row>

‎modules/rtpengine/README‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1443,7 +1443,7 @@ Chapter 3. Contributors
14431443
5. Richard Fuchs 20 2 640 723
14441444
6. Vlad Patrascu (@rvlad-patrascu) 15 7 218 330
14451445
7. Norman Brandinger (@NormB) 12 10 72 18
1446-
8. Peter Lemenkov (@lemenkov) 10 7 27 62
1446+
8. Peter Lemenkov (@lemenkov) 11 8 29 64
14471447
9. Vlad Paiu (@vladpaiu) 8 1 566 94
14481448
10. Eric Tamme (@etamme) 7 5 42 19
14491449

@@ -1475,11 +1475,11 @@ Chapter 3. Contributors
14751475
Name Commit Activity
14761476
1. Norman Brandinger (@NormB) Jun 2024 - Feb 2025
14771477
2. Razvan Crainea (@razvancrainea) Jun 2014 - Feb 2025
1478-
3. Vlad Paiu (@vladpaiu) Jan 2025 - Jan 2025
1479-
4. Eddie Fiorentine Nov 2024 - Nov 2024
1480-
5. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
1481-
6. Liviu Chircu (@liviuchircu) Jul 2014 - May 2023
1482-
7. Peter Lemenkov (@lemenkov) Jun 2018 - Apr 2022
1478+
3. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2025
1479+
4. Vlad Paiu (@vladpaiu) Jan 2025 - Jan 2025
1480+
5. Eddie Fiorentine Nov 2024 - Nov 2024
1481+
6. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
1482+
7. Liviu Chircu (@liviuchircu) Jul 2014 - May 2023
14831483
8. John Burke (@john08burke) Jun 2019 - Apr 2022
14841484
9. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2014 - Apr 2022
14851485
10. Nick Altmann (@nikbyte) May 2021 - May 2021

‎modules/rtpengine/doc/contributors.xml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@
7777
<row>
7878
<entry>8. </entry>
7979
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
80-
<entry align="center">10</entry>
81-
<entry align="center">7</entry>
82-
<entry align="center">27</entry>
83-
<entry align="center">62</entry>
80+
<entry align="center">11</entry>
81+
<entry align="center">8</entry>
82+
<entry align="center">29</entry>
83+
<entry align="center">64</entry>
8484
</row>
8585
<row>
8686
<entry>9. </entry>
@@ -138,29 +138,29 @@
138138
</row>
139139
<row>
140140
<entry>3. </entry>
141+
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
142+
<entry align="center">Jun 2018 - Feb 2025</entry>
143+
</row>
144+
<row>
145+
<entry>4. </entry>
141146
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
142147
<entry align="center">Jan 2025 - Jan 2025</entry>
143148
</row>
144149
<row>
145-
<entry>4. </entry>
150+
<entry>5. </entry>
146151
<entry>Eddie Fiorentine</entry>
147152
<entry align="center">Nov 2024 - Nov 2024</entry>
148153
</row>
149154
<row>
150-
<entry>5. </entry>
155+
<entry>6. </entry>
151156
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
152157
<entry align="center">Jan 2021 - Nov 2023</entry>
153158
</row>
154159
<row>
155-
<entry>6. </entry>
160+
<entry>7. </entry>
156161
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
157162
<entry align="center">Jul 2014 - May 2023</entry>
158163
</row>
159-
<row>
160-
<entry>7. </entry>
161-
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
162-
<entry align="center">Jun 2018 - Apr 2022</entry>
163-
</row>
164164
<row>
165165
<entry>8. </entry>
166166
<entry>John Burke (<ulink url="https://github.com/john08burke">@john08burke</ulink>)</entry>

0 commit comments

Comments
 (0)