Browse code

modules/uac: upgrade doc to module.type.name format

Vicente Hernando authored on 17/05/2013 11:30:05
Showing 1 changed files
... ...
@@ -103,7 +103,7 @@
103 103
 
104 104
 	<section>
105 105
 		<title>Parameters</title>
106
-		<section>
106
+		<section id="uac.p.rr_from_store_param">
107 107
 			<title><varname>rr_from_store_param</varname> (string)</title>
108 108
 			<para>
109 109
 			Name of Record-Route header parameter that will be used to store 
... ...
@@ -124,7 +124,7 @@ modparam("uac","rr_from_store_param","my_param")
124 124
 				</programlisting>
125 125
 			</example>
126 126
 		</section>
127
-		<section>
127
+		<section id="uac.p.rr_to_store_param">
128 128
 			<title><varname>rr_to_store_param</varname> (string)</title>
129 129
 			<para>
130 130
 			Name of Record-Route header parameter that will be used to store 
... ...
@@ -145,7 +145,7 @@ modparam("uac","rr_to_store_param","my_param")
145 145
 				</programlisting>
146 146
 			</example>
147 147
 		</section>
148
-		<section>
148
+		<section id="uac.p.restore_mode">
149 149
 			<title><varname>restore_mode</varname> (string)</title>
150 150
 			<para>
151 151
 			There are 3 modes of restoring the original FROM URI and the original TO URI:
... ...
@@ -188,7 +188,7 @@ modparam("uac","restore_mode","auto")
188 188
 				</programlisting>
189 189
 			</example>
190 190
 		</section>
191
-		<section>
191
+		<section id="uac.p.restore_dlg">
192 192
 			<title><varname>restore_dlg</varname> (int)</title>
193 193
 			<para>
194 194
 			If set to 1, the module uses dialog variables to store initial and
... ...
@@ -209,7 +209,7 @@ modparam("uac", "restore_dlg", 1)
209 209
 				</programlisting>
210 210
 			</example>
211 211
 		</section>
212
-		<section>
212
+		<section id="uac.p.restore_passwd">
213 213
 			<title><varname>restore_passwd</varname> (string)</title>
214 214
 			<para>
215 215
 			String password to be used to encrypt the RR storing parameters. If
... ...
@@ -229,7 +229,7 @@ modparam("uac","restore_passwd","my_secret_passwd")
229 229
 				</programlisting>
230 230
 			</example>
231 231
 		</section>
232
-		<section>
232
+		<section id="uac.p.restore_from_avp">
233 233
 			<title><varname>restore_from_avp</varname> (string)</title>
234 234
 			<para>
235 235
 			If defined and restore_mode is manual or auto, the avp is used to save
... ...
@@ -255,7 +255,7 @@ modparam("uac","restore_from_avp","$avp(original_uri_from)")
255 255
 				</programlisting>
256 256
 			</example>
257 257
 		</section>
258
-		<section>
258
+		<section id="uac.p.restore_to_avp">
259 259
 			<title><varname>restore_to_avp</varname> (string)</title>
260 260
 			<para>
261 261
 			If defined and restore_mode is manual or auto, the avp is used to save
... ...
@@ -280,7 +280,7 @@ modparam("uac","restore_to_avp","$avp(original_uri_to)")
280 280
 				</programlisting>
281 281
 			</example>
282 282
 		</section>
283
-		<section>
283
+		<section id="uac.p.credential">
284 284
 			<title><varname>credential</varname> (string)</title>
285 285
 			<para>
286 286
 			Contains a multiple definition of credentials used to perform
... ...
@@ -300,7 +300,7 @@ modparam("uac","credential","username:domain:password")
300 300
 				</programlisting>
301 301
 			</example>
302 302
 		</section>
303
-		<section id="auth-realm-avp-id">
303
+		<section id="uac.p.auth-realm-avp-id">
304 304
 			<title><varname>auth_realm_avp</varname> (string)</title>
305 305
 			<para>
306 306
 			The definition of an PV that might contain the realm to be used
... ...
@@ -314,9 +314,9 @@ modparam("uac","credential","username:domain:password")
314 314
 			<para><emphasis>
315 315
 				If you define it, you also need to define 
316 316
 				<quote>auth_username_avp</quote> 
317
-				(<xref linkend="auth-username-avp-id"/>) and 
317
+				(<xref linkend="uac.p.auth-username-avp-id"/>) and 
318 318
 				<quote>auth_username_avp</quote> 
319
-				(<xref linkend="auth-password-avp-id"/>).
319
+				(<xref linkend="uac.p.auth-password-avp-id"/>).
320 320
 			</emphasis></para>
321 321
 			<example>
322 322
 				<title>Set <varname>auth_realm_avp</varname> parameter</title>
... ...
@@ -327,7 +327,7 @@ modparam("uac","auth_realm_avp","$avp(i:10)")
327 327
 				</programlisting>
328 328
 			</example>
329 329
 		</section>
330
-		<section id="auth-username-avp-id">
330
+		<section id="uac.p.auth-username-avp-id">
331 331
 			<title><varname>auth_username_avp</varname> (string)</title>
332 332
 			<para>
333 333
 			The definition of an AVP that might contain the username to be used
... ...
@@ -336,9 +336,9 @@ modparam("uac","auth_realm_avp","$avp(i:10)")
336 336
 			<para><emphasis>
337 337
 				If you define it, you also need to define 
338 338
 				<quote>auth_realm_avp</quote> 
339
-				(<xref linkend="auth-realm-avp-id"/>) and 
339
+				(<xref linkend="uac.p.auth-realm-avp-id"/>) and 
340 340
 				<quote>auth_username_avp</quote> 
341
-				(<xref linkend="auth-password-avp-id"/>).
341
+				(<xref linkend="uac.p.auth-password-avp-id"/>).
342 342
 			</emphasis></para>
343 343
 			<example>
344 344
 				<title>Set <varname>auth_username_avp</varname> parameter</title>
... ...
@@ -349,7 +349,7 @@ modparam("uac","auth_username_avp","$avp(i:11)")
349 349
 				</programlisting>
350 350
 			</example>
351 351
 		</section>
352
-		<section id="auth-password-avp-id">
352
+		<section id="uac.p.auth-password-avp-id">
353 353
 			<title><varname>auth_password_avp</varname> (string)</title>
354 354
 			<para>
355 355
 			The definition of an AVP that might contain the password to be used
... ...
@@ -358,9 +358,9 @@ modparam("uac","auth_username_avp","$avp(i:11)")
358 358
 			<para><emphasis>
359 359
 				If you define it, you also need to define 
360 360
 				<quote>auth_password_avp</quote> 
361
-				(<xref linkend="auth-password-avp-id"/>) and 
361
+				(<xref linkend="uac.p.auth-password-avp-id"/>) and 
362 362
 				<quote>auth_username_avp</quote> 
363
-				(<xref linkend="auth-password-avp-id"/>).
363
+				(<xref linkend="uac.p.auth-password-avp-id"/>).
364 364
 			</emphasis></para>
365 365
 			<example>
366 366
 				<title>Set <varname>auth_password_avp</varname> parameter</title>
... ...
@@ -371,7 +371,7 @@ modparam("uac","auth_password_avp","$avp(i:12)")
371 371
 				</programlisting>
372 372
 			</example>
373 373
 		</section>
374
-		<section id="reg-db-url-id">
374
+		<section id="uac.p.reg-db-url-id">
375 375
 			<title><varname>reg_db_url</varname> (string)</title>
376 376
 			<para>
377 377
 			DB URL to fetch account profiles for registration.
... ...
@@ -387,7 +387,7 @@ modparam("uac", "reg_db_url",
387 387
 			</example>
388 388
 		</section>
389 389
 
390
-		<section id="reg-timer-interval-id">
390
+		<section id="uac.p.reg-timer-interval-id">
391 391
 			<title><varname>reg_timer_interval</varname> (string)</title>
392 392
 			<para>
393 393
 			Timer interval (in seconds) at which registrations are managed, e.g. renewed as needed.  
... ...
@@ -408,7 +408,7 @@ modparam("uac", "reg_timer_interval", 60)
408 408
 			</example>
409 409
 		</section>
410 410
 
411
-		<section id="reg-retry-interval-id">
411
+		<section id="uac.p.reg-retry-interval-id">
412 412
 			<title><varname>reg_retry_interval</varname> (int)</title>
413 413
 			<para>
414 414
 			Failed registration attempts will be retried after this interval
... ...
@@ -427,7 +427,7 @@ modparam("uac", "reg_retry_interval", 300)
427 427
 			</example>
428 428
 		</section>
429 429
 
430
-		<section id="reg-db-table-id">
430
+		<section id="uac.p.reg-db-table-id">
431 431
 			<title><varname>reg_db_table</varname> (string)</title>
432 432
 			<para>
433 433
 			DB table name to fetch user profiles for registration.
... ...
@@ -448,7 +448,7 @@ modparam("uac", "reg_db_table", "uacreg")
448 448
 			</example>
449 449
 		</section>
450 450
 
451
-		<section id="reg-contact-addr-id">
451
+		<section id="uac.p.reg-contact-addr-id">
452 452
 			<title><varname>reg_contact_addr</varname> (string)</title>
453 453
 			<para>
454 454
 			Address to be used to build contact address. Must be at least
... ...
@@ -469,7 +469,7 @@ modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
469 469
 
470 470
 	<section>
471 471
 		<title>Functions</title>
472
-		<section>
472
+		<section id="uac.f.uac_replace_from">
473 473
 			<title>
474 474
 				<function moreinfo="none">uac_replace_from(display,uri)</function>
475 475
 			</title>
... ...
@@ -526,7 +526,7 @@ uac_replace_from("","");
526 526
 				</programlisting>
527 527
 			</example>
528 528
 		</section>
529
-		<section>
529
+		<section id="uac.f.uac_replace_from(uri)">
530 530
 			<title>
531 531
 				<function moreinfo="none">uac_replace_from(uri)</function>
532 532
 			</title>
... ...
@@ -549,7 +549,7 @@ uac_replace_from("sip:batman@gotham.org");
549 549
 				</programlisting>
550 550
 			</example>
551 551
 		</section>
552
-		<section>
552
+		<section id="uac.f.uac_restore_from()">
553 553
 			<title>
554 554
 				<function moreinfo="none">uac_restore_from()</function>
555 555
 			</title>
... ...
@@ -570,7 +570,7 @@ uac_restore_from();
570 570
 				</programlisting>
571 571
 			</example>
572 572
 		</section>
573
-		<section>
573
+		<section id="uac.f.uac_replace_to(display,uri)">
574 574
 		<title>
575 575
 				<function moreinfo="none">uac_replace_to(display,uri)</function>
576 576
 			</title>
... ...
@@ -606,7 +606,7 @@ uac_replace_to("","");
606 606
 				</programlisting>
607 607
 			</example>
608 608
 		</section>
609
-		<section>
609
+		<section id="uac.f.uac_replace_to(uri)">
610 610
 			<title>
611 611
 				<function moreinfo="none">uac_replace_to(uri)</function>
612 612
 			</title>
... ...
@@ -651,7 +651,7 @@ uac_replace_to("sip:batman@gotham.org");
651 651
 				</programlisting>
652 652
 			</example>
653 653
 		</section>
654
-		<section>
654
+		<section id="uac.f.uac_restore_to()">
655 655
 			<title>
656 656
 				<function moreinfo="none">uac_restore_to()</function>
657 657
 			</title>
... ...
@@ -672,7 +672,7 @@ uac_restore_to();
672 672
 				</programlisting>
673 673
 			</example>
674 674
 		</section>
675
-		<section>
675
+		<section id="uac.f.uac_auth()">
676 676
 			<title>
677 677
 				<function moreinfo="none">uac_auth()</function>
678 678
 			</title>
... ...
@@ -693,7 +693,7 @@ uac_auth();
693 693
 				</programlisting>
694 694
 			</example>
695 695
 		</section>
696
-		<section>
696
+		<section id="uac.f.uac_req_send()">
697 697
 			<title>
698 698
 				<function moreinfo="none">uac_req_send()</function>
699 699
 			</title>
... ...
@@ -718,7 +718,7 @@ uac_req_send();
718 718
 				</programlisting>
719 719
 			</example>
720 720
 		</section>
721
-		<section>
721
+		<section id="uac.f.uac_reg_lookup(uuid, dst)">
722 722
 			<title>
723 723
 				<function moreinfo="none">uac_reg_lookup(uuid, dst)</function>
724 724
 			</title>
... ...
@@ -742,7 +742,7 @@ if(uac_reg_lookup("$rU", "$ru"))
742 742
 				</programlisting>
743 743
 			</example>
744 744
 		</section>
745
-		<section>
745
+		<section id="uac.f.uac_reg_request_to(user, mode)">
746 746
 			<title>
747 747
 				<function moreinfo="none">uac_reg_request_to(user, mode)</function>
748 748
 			</title>