siptrace: fix order of parameter for sip_trace function, add listitem structure
authorHenning Westerholt <hw@skalatan.de>
Tue, 30 Jul 2019 07:22:25 +0000 (09:22 +0200)
committerHenning Westerholt <hw@skalatan.de>
Tue, 30 Jul 2019 07:22:25 +0000 (09:22 +0200)
src/modules/siptrace/doc/siptrace_admin.xml

index 0ec443c..a60b843 100644 (file)
@@ -515,7 +515,7 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
        <title>Functions</title>
        <section id="siptrace.f.sip_trace">
                <title>
-               <function moreinfo="none">sip_trace([mode][,address][, correlation_id])</function>
+               <function moreinfo="none">sip_trace([address][,correlation_id][,mode])</function>
                </title>
                <para>
                Store or forward the current processed SIP message/transaction/dialog in database.
@@ -525,19 +525,23 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
                <para>Meaning of the parameters is as follows:</para>
                <itemizedlist>
                <listitem>
-               <para><emphasis>mode</emphasis> - SIP messages to be traced. One can trace the current message
-               (function can be called on either a reply or a request), the current transaction(the route must
-               belong to a request) or the current dialog(the message has to be an invite).
-               </para>
                <para><emphasis>address</emphasis> - The address in form of SIP URI
                where to send a duplicate of traced message. This parameter trumps
                duplicate_uri and allows tracing to more than one server.
                </para>
+               </listitem>
+               <listitem>
                <para><emphasis>correlation_id</emphasis> - A string with a correlation ID
                to be added to the HEP header when using HEPv3.
                It's possible to use PVs.
                </para>
                </listitem>
+               <listitem>
+               <para><emphasis>mode</emphasis> - SIP messages to be traced. One can trace the current message
+               (function can be called on either a reply or a request), the current transaction(the route must
+               belong to a request) or the current dialog(the message has to be an invite).
+               </para>
+               </listitem>
                </itemizedlist>
                <para>
                This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,