Browse Source

tcpops Add docbook entities to README and fix spelling errors

Olle E. Johansson 9 years ago
parent
commit
247158a15f
3 changed files with 39 additions and 22 deletions
  1. 22 17
      modules/tcpops/doc/functions.xml
  2. 9 3
      modules/tcpops/doc/params.xml
  3. 8 2
      modules/tcpops/doc/tcpops.xml

+ 22 - 17
modules/tcpops/doc/functions.xml

@@ -1,6 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
-   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general Kamailio documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
 
 
 <section id="print.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
 <section id="print.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
 	<sectioninfo>
 	<sectioninfo>
@@ -23,7 +29,7 @@
 				</para>
 				</para>
 			</listitem>
 			</listitem>
 		</itemizedlist>
 		</itemizedlist>
-		<para>Retuns values:</para>
+		<para>Return values:</para>
 		<para>1: Connection is OK</para>
 		<para>1: Connection is OK</para>
 		<para>-1: Connection has errors, does not exist or is about to be closed)</para>
 		<para>-1: Connection has errors, does not exist or is about to be closed)</para>
 		<example>
 		<example>
@@ -53,7 +59,7 @@
 				</para>
 				</para>
 			</listitem>
 			</listitem>
 		</itemizedlist>
 		</itemizedlist>
-		<para>Retuns values:</para>
+		<para>Return values:</para>
 		<para>1: Connection is OK</para>
 		<para>1: Connection is OK</para>
 		<para>2: Socket is accepting incoming connections</para>
 		<para>2: Socket is accepting incoming connections</para>
 		<para>3: Socket is setting up outgoing connection</para>
 		<para>3: Socket is setting up outgoing connection</para>
@@ -78,12 +84,12 @@
 			<function>tcp_keepalive_enable([conid], idle, count, interval)</function>
 			<function>tcp_keepalive_enable([conid], idle, count, interval)</function>
 		</title>
 		</title>
 		<para>
 		<para>
-				Enables keepalive on a TCP connection.
+			Enables keepalive on a TCP connection.
 		</para>
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<itemizedlist>
 			<listitem>
 			<listitem>
-				<para><emphasis>conid</emphasis> (optional): the kamailio internal
+				<para><emphasis>conid</emphasis> (optional): the &kamailio; internal
 				connection id on which TCP keepalive will be enabled. If no parameter
 				connection id on which TCP keepalive will be enabled. If no parameter
 				is given, the keepalive mechanism will be enabled on the current message
 				is given, the keepalive mechanism will be enabled on the current message
 				source connection.
 				source connection.
@@ -105,7 +111,7 @@
 				</para>
 				</para>
 			</listitem>
 			</listitem>
 		</itemizedlist>
 		</itemizedlist>
-		<para>Retuns 1 on success, -1 on failure.</para>
+		<para>Returns 1 on success, -1 on failure.</para>
 		<example>
 		<example>
 			<title><function>tcp_keepalive_enable</function> usage</title>
 			<title><function>tcp_keepalive_enable</function> usage</title>
 			<programlisting><![CDATA[
 			<programlisting><![CDATA[
@@ -135,19 +141,19 @@ onreply_route[foo] {
 			<function>tcp_keepalive_disable([conid])</function>
 			<function>tcp_keepalive_disable([conid])</function>
 		</title>
 		</title>
 		<para>
 		<para>
-				Disables keepalive on a TCP connection.
+			Disables keepalive on a TCP connection.
 		</para>
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
 		<itemizedlist>
 			<listitem>
 			<listitem>
-				<para><emphasis>conid</emphasis> (optional): the kamailio internal
+				<para><emphasis>conid</emphasis> (optional): the &kamailio; internal
 				connection id on which TCP keepalive will be disabled. If no parameter
 				connection id on which TCP keepalive will be disabled. If no parameter
 				is given, the keepalive mechanism will be disabled on the current message
 				is given, the keepalive mechanism will be disabled on the current message
 				source connection.
 				source connection.
 				</para>
 				</para>
 			</listitem>
 			</listitem>
 		</itemizedlist>
 		</itemizedlist>
-		<para>Retuns 1 on success, -1 on failure.</para>
+		<para>Returns 1 on success, -1 on failure.</para>
 		<example>
 		<example>
 			<title><function>tcp_keepalive_disable</function> usage</title>
 			<title><function>tcp_keepalive_disable</function> usage</title>
 			<programlisting><![CDATA[
 			<programlisting><![CDATA[
@@ -176,12 +182,12 @@ onreply_route[foo] {
                         <function>tcp_set_connection_lifetime([conid], lifetime)</function>
                         <function>tcp_set_connection_lifetime([conid], lifetime)</function>
                 </title>
                 </title>
                 <para>
                 <para>
-                                Sets the connection lifetime of a connection (TCP).
+			Sets the connection lifetime of a connection (TCP).
                 </para>
                 </para>
                 <para>Meaning of the parameters is as follows:</para>
                 <para>Meaning of the parameters is as follows:</para>
                 <itemizedlist>
                 <itemizedlist>
                         <listitem>
                         <listitem>
-                                <para><emphasis>conid</emphasis> (optional): the kamailio internal
+                                <para><emphasis>conid</emphasis> (optional): the &kamailio; internal
                                 connection id on which to set the new lifetime. If no parameter
                                 connection id on which to set the new lifetime. If no parameter
                                 is given, it will be set on the current message source connection.
                                 is given, it will be set on the current message source connection.
                                 </para>
                                 </para>
@@ -191,7 +197,7 @@ onreply_route[foo] {
                                 </para>
                                 </para>
                         </listitem>
                         </listitem>
                 </itemizedlist>
                 </itemizedlist>
-                <para>Retuns 1 on success, -1 on failure.</para>
+                <para>Returns 1 on success, -1 on failure.</para>
                 <example>
                 <example>
                         <title><function>tcp_set_connection_lifetime</function> usage</title>
                         <title><function>tcp_set_connection_lifetime</function> usage</title>
                         <programlisting><![CDATA[
                         <programlisting><![CDATA[
@@ -217,19 +223,18 @@ request_route {
                         <function>tcp_enable_closed_event([conid])</function>
                         <function>tcp_enable_closed_event([conid])</function>
                 </title>
                 </title>
                 <para>
                 <para>
-                                Explicitly enables the "tcp:closed" event route
-                                on a TCP connection.
+			Explicitly enables the "tcp:closed" event route on a TCP connection.
                 </para>
                 </para>
                 <para>Meaning of the parameters is as follows:</para>
                 <para>Meaning of the parameters is as follows:</para>
                 <itemizedlist>
                 <itemizedlist>
                         <listitem>
                         <listitem>
-                                <para><emphasis>conid</emphasis> (optionnal): the kamailio internal
+                                <para><emphasis>conid</emphasis> (optionnal): the &kamailio; internal
                                 connection id. If no parameter
                                 connection id. If no parameter
                                 is given, it will be enabled on the current message source connection.
                                 is given, it will be enabled on the current message source connection.
                                 </para>
                                 </para>
                         </listitem>
                         </listitem>
                 </itemizedlist>
                 </itemizedlist>
-                <para>Retuns 1 on success, -1 on failure.</para>
+                <para>Returns 1 on success, -1 on failure.</para>
                 <example>
                 <example>
                         <title><function>tcp_set_closed_event</function> usage</title>
                         <title><function>tcp_set_closed_event</function> usage</title>
                         <programlisting><![CDATA[
                         <programlisting><![CDATA[

+ 9 - 3
modules/tcpops/doc/params.xml

@@ -1,6 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
-   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general Kamailio documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
 
 
 <section id="print.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
 <section id="print.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
     <sectioninfo>
     <sectioninfo>
@@ -10,7 +16,7 @@
 		<section>
 		<section>
 		<title><varname>closed_event</varname> (int)</title>
 		<title><varname>closed_event</varname> (int)</title>
 		<para>
 		<para>
-			If set to 0 (gloabbly disabled), the "tcp:closed" event route will never be called on TCP
+			If set to 0 (globally disabled), the "tcp:closed" event route will never be called on TCP
 			disconnections.
 			disconnections.
 		</para>
 		</para>
 		<para>
 		<para>

+ 8 - 2
modules/tcpops/doc/tcpops.xml

@@ -1,6 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
-   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general Kamailio documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
 
 
 <book id="print" xmlns:xi="http://www.w3.org/2001/XInclude">
 <book id="print" xmlns:xi="http://www.w3.org/2001/XInclude">
     <bookinfo>
     <bookinfo>