瀏覽代碼

avp Documentation typo fix and update (SER => Kamailio)

Olle E. Johansson 12 年之前
父節點
當前提交
c79c33f14d
共有 3 個文件被更改,包括 14 次插入15 次删除
  1. 6 6
      modules/avp/README
  2. 4 4
      modules/avp/doc/avp.xml
  3. 4 5
      modules/avp/doc/avp_functions.xml

+ 6 - 6
modules/avp/README

@@ -35,11 +35,11 @@ Michal Matyska
    the contents of AVPs (Attribute-Value pairs). The AVPs are variables
    the contents of AVPs (Attribute-Value pairs). The AVPs are variables
    attached to the SIP message being processed. Each variable has its name
    attached to the SIP message being processed. Each variable has its name
    and value. AVPs can be used to store arbitrary data or as a means of
    and value. AVPs can be used to store arbitrary data or as a means of
-   inter-module comminication.
+   inter-module communication.
 
 
    You may also want to check the avpops module which is more flexible and
    You may also want to check the avpops module which is more flexible and
-   contains more functions. In future SER releases the avp module will be
-   probably deprecated in favor of avpops module.
+   contains more functions. In future Kamailio releases the avp module
+   will be probably deprecated in favor of avpops module.
 
 
 2. Functions
 2. Functions
 
 
@@ -84,7 +84,7 @@ set_iattr("fr_inv_timer", "60")
 
 
 2.2. flags2attr("$avp")
 2.2. flags2attr("$avp")
 
 
-   Store the current state of SER flags into the sepcified avp.
+   Store the current state of Kamailio flags into the specified AVP.
 
 
    Example 2. flags2attr usage
    Example 2. flags2attr usage
 ...
 ...
@@ -140,9 +140,9 @@ set_sattr("called_number", "1234")
    Example 4. attr_exists usage
    Example 4. attr_exists usage
 ...
 ...
 if (attr_exists("saved_ruri")) {
 if (attr_exists("saved_ruri")) {
-  attr2uri("saved_uri");
+    attr2uri("saved_uri");
 } else {
 } else {
-  rewriteuri("sip:[email protected]");
+    rewriteuri("sip:[email protected]");
 };
 };
 ...
 ...
 
 

+ 4 - 4
modules/avp/doc/avp.xml

@@ -28,7 +28,7 @@
 	</copyright>
 	</copyright>
     </bookinfo>
     </bookinfo>
 
 
-    <title>Avp Module</title>
+    <title>The AVP Module</title>
 
 
     <section>
     <section>
 	<title>Overview</title>
 	<title>Overview</title>
@@ -37,11 +37,11 @@
 	    manipulate the contents of AVPs (Attribute-Value pairs). The AVPs
 	    manipulate the contents of AVPs (Attribute-Value pairs). The AVPs
 	    are variables attached to the SIP message being processed. Each
 	    are variables attached to the SIP message being processed. Each
 	    variable has its name and value. AVPs can be used to store
 	    variable has its name and value. AVPs can be used to store
-	    arbitrary data or as a means of inter-module comminication.
+	    arbitrary data or as a means of inter-module communication.
 	</para>
 	</para>
 	<para>
 	<para>
-	    You may also want to check the avpops module which is more flexible
-	    and contains more functions. In future SER releases the avp module
+	    You may also want to check the <emphasis>avpops</emphasis> module which is more flexible
+	    and contains more functions. In future &kamailio; releases the avp module
 	    will be probably deprecated in favor of avpops module.
 	    will be probably deprecated in favor of avpops module.
 	</para>
 	</para>
     </section>
     </section>

+ 4 - 5
modules/avp/doc/avp_functions.xml

@@ -41,7 +41,7 @@ set_iattr("fr_inv_timer", "60")
     <section id="flags2attr">
     <section id="flags2attr">
 	<title><function>flags2attr("$avp")</function></title>
 	<title><function>flags2attr("$avp")</function></title>
 	<para>
 	<para>
-	    Store the current state of SER flags into the sepcified avp.
+	    Store the current state of &kamailio; flags into the specified AVP.
 	</para>
 	</para>
 	<example>
 	<example>
 	    <title><function>flags2attr</function> usage</title>
 	    <title><function>flags2attr</function> usage</title>
@@ -89,8 +89,7 @@ set_sattr("called_number", "1234")
 	<para>Meaning of the parameter is as follows:</para>
 	<para>Meaning of the parameter is as follows:</para>
 	<itemizedlist>
 	<itemizedlist>
 	    <listitem>
 	    <listitem>
-		<para><emphasis>attribute</emphasis> - The name of the
-		    AVP.
+		<para><emphasis>attribute</emphasis> - The name of the AVP.
 		</para>
 		</para>
 	    </listitem>
 	    </listitem>
 	</itemizedlist>
 	</itemizedlist>
@@ -144,9 +143,9 @@ set_sattr("called_number", "1234")
 	    <programlisting>
 	    <programlisting>
 ...
 ...
 if (attr_exists("saved_ruri")) {
 if (attr_exists("saved_ruri")) {
-  attr2uri("saved_uri");
+    attr2uri("saved_uri");
 } else {
 } else {
-  rewriteuri("sip:[email protected]");
+    rewriteuri("sip:[email protected]");
 };
 };
 ...
 ...
 		</programlisting>
 		</programlisting>