[asterisk-commits] lmadsen: trunk r249892 - in /trunk: apps/ res/

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Tue Mar 2 13:03:00 CST 2010


Author: lmadsen
Date: Tue Mar  2 13:02:56 2010
New Revision: 249892

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=249892
Log:
Fix several XML documentation validate errors.

Modified:
    trunk/apps/app_confbridge.c
    trunk/apps/app_osplookup.c
    trunk/res/res_jabber.c

Modified: trunk/apps/app_confbridge.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_confbridge.c?view=diff&rev=249892&r1=249891&r2=249892
==============================================================================
--- trunk/apps/app_confbridge.c (original)
+++ trunk/apps/app_confbridge.c Tue Mar  2 13:02:56 2010
@@ -97,7 +97,7 @@
                 <description>
                         <para>Enters the user into a specified conference bridge. The user can exit the conference by hangup only.</para>
                         <para>The join sound can be set using the <literal>CONFBRIDGE_JOIN_SOUND</literal> variable and the leave sound can be set using the <literal>CONFBRIDGE_LEAVE_SOUND</literal> variable. These can be unique to the caller.</para>
-			<note>This application will not automatically answer the channel.</note>
+			<note><para>This application will not automatically answer the channel.</para></note>
                 </description>
         </application>
 ***/

Modified: trunk/apps/app_osplookup.c
URL: http://svnview.digium.com/svn/asterisk/trunk/apps/app_osplookup.c?view=diff&rev=249892&r1=249891&r2=249892
==============================================================================
--- trunk/apps/app_osplookup.c (original)
+++ trunk/apps/app_osplookup.c Tue Mar  2 13:02:56 2010
@@ -58,6 +58,14 @@
 		<synopsis>
 			OSP Authentication.
 		</synopsis>
+		<syntax>
+			<parameter name="provider">
+				<para>The name of the provider that authenticates the call.</para>
+			</parameter>
+			<parameter name="options">
+				<para>Reserverd.</para>
+			</parameter>
+		</syntax>
 		<description>
 			<para>Authenticate a call by OSP.</para>
 			<para>Input variables:</para>
@@ -88,14 +96,6 @@
 				</variable>
 			</variablelist>
 		</description>
-		<syntax>
-			<parameter name="provider">
-				<para>The name of the provider that authenticates the call.</para>
-			</parameter>
-			<parameter name="options">
-				<para>Reserverd.</para>
-			</parameter>
-		</syntax>
 		<see-also>
 			<ref type="application">OSPLookup</ref>
 			<ref type="application">OSPNext</ref>
@@ -106,139 +106,6 @@
 		<synopsis>
 			Lookup destination by OSP.
 		</synopsis>
-		<description>
-			<para>Looks up destination via OSP.</para>
-			<para>Input variables:</para>
-			<variablelist>
-				<variable name="OSPINPEERIP">
-					<para>The last hop IP address.</para>
-				</variable>
-				<variable name="OSPINHANDLE">
-					<para>The inbound call OSP transaction handle.</para>
-				</variable>
-				<variable name="OSPINTIMELIMIT">
-					<para>The inbound call duration limit in seconds.</para>
-				</variable>
-				<variable name="OSPINNETWORKID">
-					<para>The inbound source network ID.</para>
-				</variable>
-				<variable name="OSPINNPRN">
-					<para>The inbound routing number.</para>
-				</variable>
-				<variable name="OSPINNPCIC">
-					<para>The inbound carrier identification code.</para>
-				</variable>
-				<variable name="OSPINNPDI">
-					<para>The inbound number portability database dip indicator.</para>
-				</variable>
-				<variable name="OSPINSPID">
-					<para>The inbound service provider identity.</para>
-				</variable>
-				<variable name="OSPINOCN">
-					<para>The inbound operator company number.</para>
-				</variable>
-				<variable name="OSPINSPN">
-					<para>The inbound service provider name.</para>
-				</variable>
-				<variable name="OSPINALTSPN">
-					<para>The inbound alternate service provider name.</para>
-				</variable>
-				<variable name="OSPINMCC">
-					<para>The inbound mobile country code.</para>
-				</variable>
-				<variable name="OSPINMNC">
-					<para>The inbound mobile network code.</para>
-				</variable>
-				<variable name="OSPINTOHOST">
-					<para>The inbound To header host part.</para>
-				</variable>
-				<variable name="OSPINDIVUSER">
-					<para>The inbound Diversion header user part.</para>
-				</variable>
-				<variable name="OSPINDIVHOST">
-					<para>The inbound Diversion header host part.</para>
-				</variable>
-				<variable name="OSPINCUSTOMINFOn">
-					<para>The inbound custom information, where <literal>n</literal> is the index beginning with <literal>1</literal>
-					upto <literal>8</literal>.</para>
-				</variable>
-			</variablelist>
-			<para>Output variables:</para>
-			<variablelist>
-				<variable name="OSPOUTHANDLE">
-					<para>The outbound call OSP transaction handle.</para>
-				</variable>
-				<variable name="OSPOUTTECH">
-					<para>The outbound channel technology for the call.</para>
-				</variable>
-				<variable name="OSPDESTINATION">
-					<para>The outbound destination IP address.</para>
-				</variable>
-				<variable name="OSPOUTCALLING">
-					<para>The outbound calling number.</para>
-				</variable>
-				<variable name="OSPOUTCALLED">
-					<para>The outbound called number.</para>
-				</variable>
-				<variable name="OSPOUTNETWORKID">
-					<para>The outbound destination network ID.</para>
-				</variable>
-				<variable name="OSPOUTNPRN">
-					<para>The outbound routing number.</para>
-				</variable>
-				<variable name="OSPOUTNPCIC">
-					<para>The outbound carrier identification code.</para>
-				</variable>
-				<variable name="OSPOUTNPDI">
-					<para>The outbound number portability database dip indicator.</para>
-				</variable>
-				<variable name="OSPOUTSPID">
-					<para>The outbound service provider identity.</para>
-				</variable>
-				<variable name="OSPOUTOCN">
-					<para>The outbound operator company number.</para>
-				</variable>
-				<variable name="OSPOUTSPN">
-					<para>The outbound service provider name.</para>
-				</variable>
-				<variable name="OSPOUTALTSPN">
-					<para>The outbound alternate service provider name.</para>
-				</variable>
-				<variable name="OSPOUTMCC">
-					<para>The outbound mobile country code.</para>
-				</variable>
-				<variable name="OSPOUTMNC">
-					<para>The outbound mobile network code.</para>
-				</variable>
-				<variable name="OSPOUTTOKEN">
-					<para>The outbound OSP token.</para>
-				</variable>
-				<variable name="OSPDESTREMAILS">
-					<para>The number of remained destinations.</para>
-				</variable>
-				<variable name="OSPOUTTIMELIMIT">
-					<para>The outbound call duration limit in seconds.</para>
-				</variable>
-				<variable name="OSPOUTCALLIDTYPES">
-					<para>The outbound Call-ID types.</para>
-				</variable>
-				<variable name="OSPOUTCALLID">
-					<para>The outbound Call-ID. Only for H.323.</para>
-				</variable>
-				<variable name="OSPDIALSTR">
-					<para>The outbound Dial command string.</para>
-				</variable>
-			</variablelist>
-			<para>This application sets the following channel variable upon completion:</para>
-			<variablelist>
-				<variable name="OSPLOOKUPSTATUS">
-					<para>The status of OSPLookup attempt as a text string, one of</para>
-					<value name="SUCCESS" />
-					<value name="FAILED" />
-					<value name="ERROR" />
-				</variable>
-			</variablelist>
-		</description>
 		<syntax>
 			<parameter name="exten" required="true">
 				<para>The exten of the call.</para>
@@ -260,6 +127,139 @@
 				</enumlist>
 			</parameter>
 		</syntax>
+		<description>
+			<para>Looks up destination via OSP.</para>
+			<para>Input variables:</para>
+			<variablelist>
+				<variable name="OSPINPEERIP">
+					<para>The last hop IP address.</para>
+				</variable>
+				<variable name="OSPINHANDLE">
+					<para>The inbound call OSP transaction handle.</para>
+				</variable>
+				<variable name="OSPINTIMELIMIT">
+					<para>The inbound call duration limit in seconds.</para>
+				</variable>
+				<variable name="OSPINNETWORKID">
+					<para>The inbound source network ID.</para>
+				</variable>
+				<variable name="OSPINNPRN">
+					<para>The inbound routing number.</para>
+				</variable>
+				<variable name="OSPINNPCIC">
+					<para>The inbound carrier identification code.</para>
+				</variable>
+				<variable name="OSPINNPDI">
+					<para>The inbound number portability database dip indicator.</para>
+				</variable>
+				<variable name="OSPINSPID">
+					<para>The inbound service provider identity.</para>
+				</variable>
+				<variable name="OSPINOCN">
+					<para>The inbound operator company number.</para>
+				</variable>
+				<variable name="OSPINSPN">
+					<para>The inbound service provider name.</para>
+				</variable>
+				<variable name="OSPINALTSPN">
+					<para>The inbound alternate service provider name.</para>
+				</variable>
+				<variable name="OSPINMCC">
+					<para>The inbound mobile country code.</para>
+				</variable>
+				<variable name="OSPINMNC">
+					<para>The inbound mobile network code.</para>
+				</variable>
+				<variable name="OSPINTOHOST">
+					<para>The inbound To header host part.</para>
+				</variable>
+				<variable name="OSPINDIVUSER">
+					<para>The inbound Diversion header user part.</para>
+				</variable>
+				<variable name="OSPINDIVHOST">
+					<para>The inbound Diversion header host part.</para>
+				</variable>
+				<variable name="OSPINCUSTOMINFOn">
+					<para>The inbound custom information, where <literal>n</literal> is the index beginning with <literal>1</literal>
+					upto <literal>8</literal>.</para>
+				</variable>
+			</variablelist>
+			<para>Output variables:</para>
+			<variablelist>
+				<variable name="OSPOUTHANDLE">
+					<para>The outbound call OSP transaction handle.</para>
+				</variable>
+				<variable name="OSPOUTTECH">
+					<para>The outbound channel technology for the call.</para>
+				</variable>
+				<variable name="OSPDESTINATION">
+					<para>The outbound destination IP address.</para>
+				</variable>
+				<variable name="OSPOUTCALLING">
+					<para>The outbound calling number.</para>
+				</variable>
+				<variable name="OSPOUTCALLED">
+					<para>The outbound called number.</para>
+				</variable>
+				<variable name="OSPOUTNETWORKID">
+					<para>The outbound destination network ID.</para>
+				</variable>
+				<variable name="OSPOUTNPRN">
+					<para>The outbound routing number.</para>
+				</variable>
+				<variable name="OSPOUTNPCIC">
+					<para>The outbound carrier identification code.</para>
+				</variable>
+				<variable name="OSPOUTNPDI">
+					<para>The outbound number portability database dip indicator.</para>
+				</variable>
+				<variable name="OSPOUTSPID">
+					<para>The outbound service provider identity.</para>
+				</variable>
+				<variable name="OSPOUTOCN">
+					<para>The outbound operator company number.</para>
+				</variable>
+				<variable name="OSPOUTSPN">
+					<para>The outbound service provider name.</para>
+				</variable>
+				<variable name="OSPOUTALTSPN">
+					<para>The outbound alternate service provider name.</para>
+				</variable>
+				<variable name="OSPOUTMCC">
+					<para>The outbound mobile country code.</para>
+				</variable>
+				<variable name="OSPOUTMNC">
+					<para>The outbound mobile network code.</para>
+				</variable>
+				<variable name="OSPOUTTOKEN">
+					<para>The outbound OSP token.</para>
+				</variable>
+				<variable name="OSPDESTREMAILS">
+					<para>The number of remained destinations.</para>
+				</variable>
+				<variable name="OSPOUTTIMELIMIT">
+					<para>The outbound call duration limit in seconds.</para>
+				</variable>
+				<variable name="OSPOUTCALLIDTYPES">
+					<para>The outbound Call-ID types.</para>
+				</variable>
+				<variable name="OSPOUTCALLID">
+					<para>The outbound Call-ID. Only for H.323.</para>
+				</variable>
+				<variable name="OSPDIALSTR">
+					<para>The outbound Dial command string.</para>
+				</variable>
+			</variablelist>
+			<para>This application sets the following channel variable upon completion:</para>
+			<variablelist>
+				<variable name="OSPLOOKUPSTATUS">
+					<para>The status of OSPLookup attempt as a text string, one of</para>
+					<value name="SUCCESS" />
+					<value name="FAILED" />
+					<value name="ERROR" />
+				</variable>
+			</variablelist>
+		</description>
 		<see-also>
 			<ref type="application">OSPAuth</ref>
 			<ref type="application">OSPNext</ref>
@@ -360,17 +360,6 @@
 				</variable>
 			</variablelist>
 		</description>
-		<syntax>
-			<parameter name="cause" required="true">
-				<para>The termaintion cause of the previous call attempt.</para>
-			</parameter>
-			<parameter name="provider">
-				<para>The name of the provider that is used to route the call.</para>
-			</parameter>
-			<parameter name="options">
-				<para>Reserved.</para>
-			</parameter>
-		</syntax>
 		<see-also>
 			<ref type="application">OSPAuth</ref>
 			<ref type="application">OSPLookup</ref>
@@ -381,6 +370,14 @@
 		<synopsis>
 			Report OSP entry.
 		</synopsis>
+		<syntax>
+			<parameter name="cause">
+				<para>Hangup cause.</para>
+			</parameter>
+			<parameter name="options">
+				<para>Reserved.</para>
+			</parameter>
+		</syntax>
 		<description>
 			<para>Report call state.</para>
 			<para>Input variables:</para>
@@ -417,14 +414,6 @@
 				</variable>
 			</variablelist>
 		</description>
-		<syntax>
-			<parameter name="cause">
-				<para>Hangup cause.</para>
-			</parameter>
-			<parameter name="options">
-				<para>Reserved.</para>
-			</parameter>
-		</syntax>
 		<see-also>
 			<ref type="application">OSPAuth</ref>
 			<ref type="application">OSPLookup</ref>

Modified: trunk/res/res_jabber.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_jabber.c?view=diff&rev=249892&r1=249891&r2=249892
==============================================================================
--- trunk/res/res_jabber.c (original)
+++ trunk/res/res_jabber.c Tue Mar  2 13:02:56 2010
@@ -174,7 +174,7 @@
 	</application>
 	<application name="JabberJoin" language="en_US">
 		<synopsis>
-			<para>Join a chat room</para>
+			Join a chat room
 		</synopsis>
 		<syntax>
 			<parameter name="Jabber" required="true">
@@ -194,7 +194,7 @@
 	</application>
 	<application name="JabberLeave" language="en_US">
 		<synopsis>
-			<para>Leave a chat room</para>
+			Leave a chat room
 		</synopsis>
 		<syntax>
 			<parameter name="Jabber" required="true">




More information about the asterisk-commits mailing list