Skip to content

Commit

Permalink
avp: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@miconda
miconda committed Nov 13, 2023
1 parent 4876b74 commit 6acc4e2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 31 deletions.
60 changes: 30 additions & 30 deletions src/modules/avp/doc/avp_functions.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</para>
</listitem>
</itemizedlist>

<example>
<title><function>set_iattr</function> usage</title>
<programlisting>
Expand All @@ -43,7 +43,7 @@ set_iattr("fr_inv_timer", "60")
</programlisting>
</example>
</section>

<section id="avp.f.flags2attr">
<title><function>flags2attr("$avp")</function></title>
<para>
Expand All @@ -58,7 +58,7 @@ flags2attr("$msg_flags")
</programlisting>
</example>
</section>

<section id="avp.f.set_sattr">
<title><function>set_sattr(attribute, value)</function></title>
<para>
Expand All @@ -76,7 +76,7 @@ flags2attr("$msg_flags")
</para>
</listitem>
</itemizedlist>

<example>
<title><function>set_sattr</function> usage</title>
<programlisting>
Expand All @@ -100,7 +100,7 @@ set_sattr("called_number", "1234")
</listitem>
</itemizedlist>
</section>

<section id="avp.f.attr2uri">
<title><function>attr2uri($attribute[, uri-part])</function></title>
<para>
Expand All @@ -119,8 +119,8 @@ set_sattr("called_number", "1234")
that will be rewritten. The supported values are: "prefix",
"uri", "username", "user", "usernamepassword", "userpass",
"domain", "host", "domainport", "hostport", "port", "strip",
"strip_tail". "prefix" will add the AVP as a prefix to the
username (equivalent to prefix("string")), "strip" and
"strip_tail". "prefix" will add the AVP as a prefix to the
username (equivalent to prefix("string")), "strip" and
"strip_tail" expect a number in the AVP and they will remove the
specified number of characters from the beginning, respective the
end of the username part of the uri. The rest of the uri-part
Expand Down Expand Up @@ -158,7 +158,7 @@ if (attr_exists("saved_ruri")) {
</example>
</section>


<section id="avp.f.attr_equals">
<title><function>attr_equals(attribute, value)</function></title>
<para>
Expand All @@ -180,7 +180,7 @@ if (attr_exists("saved_ruri")) {
</listitem>
</itemizedlist>
</section>

<section id="avp.f.attr_equals_xl">
<title><function>attr_equals_xl(attribute, xl_format)</function></title>
<para>
Expand Down Expand Up @@ -216,15 +216,15 @@ if (attr_equals_xl("my_avp", "%ct")) {
</programlisting>
</example>
</section>

<section id="avp.f.dump_attrs">
<title><function>dump_attrs()</function></title>
<para>
Dumps all AVPs in user lists to the debug output (with level INFO).
</para>
<para>The function does not require any parameters.</para>
</section>

<section id="avp.f.xlset_attr">
<title><function>xlset_attr($attribute, xl_format)</function></title>
<para>
Expand Down Expand Up @@ -261,8 +261,8 @@ if (attr_equals_xl("my_avp", "%ct")) {
</listitem>
</itemizedlist>
</section>


<section id="avp.f.insert_attr_hf_1">
<title><function>insert_attr_hf(name)</function></title>
<para>
Expand All @@ -283,7 +283,7 @@ if (attr_equals_xl("my_avp", "%ct")) {
</listitem>
</itemizedlist>
</section>

<section id="avp.f.insert_attr_hf_2">
<title><function>insert_attr_hf(header_name, $avp_name)</function></title>
<para>
Expand Down Expand Up @@ -317,7 +317,7 @@ insert_attr_hf("Route", "$my_route");
</programlisting>
</example>
</section>

<section id="avp.f.append_attr_hf_1">
<title><function>append_attr_hf(name)</function></title>
<para>
Expand All @@ -338,7 +338,7 @@ insert_attr_hf("Route", "$my_route");
</listitem>
</itemizedlist>
</section>

<section id="avp.f.append_attr_hf_2">
<title><function>append_attr_hf(header_name, $avp_name)</function></title>
<para>
Expand All @@ -363,7 +363,7 @@ insert_attr_hf("Route", "$my_route");
</listitem>
</itemizedlist>
</section>

<section id="avp.f.replace_attr_hf_1">
<title><function>replace_attr_hf(name)</function></title>
<para>
Expand All @@ -384,7 +384,7 @@ insert_attr_hf("Route", "$my_route");
</listitem>
</itemizedlist>
</section>

<section id="avp.f.replace_attr_hf_2">
<title><function>replace_attr_hf(header_name, $avp_name)</function></title>
<para>
Expand All @@ -409,7 +409,7 @@ insert_attr_hf("Route", "$my_route");
</listitem>
</itemizedlist>
</section>

<section id="avp.f.attr_to_reply_1">
<title><function>attr_to_reply(name)</function></title>
<para>
Expand All @@ -423,18 +423,18 @@ insert_attr_hf("Route", "$my_route");
<itemizedlist>
<listitem>
<para><emphasis>name</emphasis>
- The name of the header field which is appended into
- The name of the header field which is appended into
reply as well as name of AVP which's value is put as the header field
value.
</para>
</listitem>
</itemizedlist>
</section>

<section id="avp.f.attr_to_reply_2">
<title><function>attr_to_reply(header_name, $avp_name)</function></title>
<para>
Appends new header into the reply at the request time processing.
Appends new header into the reply at the request time processing.
</para>
<para>Meaning of the parameter is as follows:</para>
<itemizedlist>
Expand All @@ -461,11 +461,11 @@ attr_to_reply("P-Hint-Route", "my_route");
</programlisting>
</example>
</section>

<section id="avp.f.attr_destination">
<title><function>attr_destination($avp_name)</function></title>
<para>
Sets the destination of the forwarded request to the value of AVP,
Sets the destination of the forwarded request to the value of AVP,
which must be either a SIP URI or a string in nameaddr format
(e.g. "Foo Bar" &lt;sip:uri&gt;).
</para>
Expand All @@ -489,7 +489,7 @@ t_relay();
</programlisting>
</example>
</section>

<section id="avp.f.xlset_destination">
<title><function>xlset_destination(xl_format)</function></title>
<para>
Expand All @@ -514,7 +514,7 @@ t_relay();
</programlisting>
</example>
</section>

<section id="avp.f.subst_attr">
<title><function>subst_attr($avp_name, subst_re)</function></title>
<para>
Expand Down Expand Up @@ -545,7 +545,7 @@ subst_attr("$uri","/tel:[0-9]*/sip:\1@foo.bar;user=phone/");
</programlisting>
</example>
</section>

<section id="avp.f.del_attr">
<title><function>del_attr($avp_name)</function></title>
<para>
Expand Down Expand Up @@ -576,11 +576,11 @@ failure_route[1] {
</programlisting>
</example>
</section>

<section id="avp.f.hdr_body2attrs">
<title><function>hdr_body2attrs(headername, prefix)</function></title>
<para>
Function parses a header body content scans for fld1=val1,fld2=val2,... and creates bunch of avps prefixfld1:= val1, prefixfld2:= val2, ....
Function parses a header body content scans for fld1=val1,fld2=val2,... and creates bunch of avps prefixfld1:= val1, prefixfld2:= val2, ....
If possible stores values as integers.
</para>
<para>Meaning of the parameter is as follows:</para>
Expand All @@ -603,7 +603,7 @@ failure_route[1] {
<section id="avp.f.hdr_body2attrs2">
<title><function>hdr_body2attrs2(headername, prefix)</function></title>
<para>
Function parses a header body content scans for fld1=val1,val2;fld2=val3,... and creates bunch of avps prefixfld1#1:= val1, prefixfld1#2:= val2, prefixfld2:=val3 ....
Function parses a header body content scans for fld1=val1,val2;fld2=val3,... and creates bunch of avps prefixfld1#1:= val1, prefixfld1#2:= val2, prefixfld2:=val3 ....
If possible stores values as integers.
</para>
<para>Meaning of the parameter is as follows:</para>
Expand Down
2 changes: 1 addition & 1 deletion src/modules/avp/doc/avp_params.xml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="avp.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
Expand Down

0 comments on commit 6acc4e2

Please sign in to comment.