[asterisk-commits] eliel: branch group/appdocsxml r147802 - /team/group/appdocsxml/main/pbx.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Thu Oct  9 08:38:49 2008
New Revision: 147802

URL: http://svn.digium.com/view/asterisk?view=rev&rev=147802
Log:
Introduce EXCEPTION() function XML documentation.

Modified:
    team/group/appdocsxml/main/pbx.c

Modified: team/group/appdocsxml/main/pbx.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/pbx.c?view=diff&rev=147802&r1=147801&r2=147802
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Thu Oct  9 08:38:49 2008
@@ -588,6 +588,34 @@
 			<para>See Also: Playback(application), Background(application).</para>
 		</description>
 	</application>
+	<function name="EXCEPTION" language="en_US">
+		<synopsis>
+			Retrieve the details of the current dialplan exception.
+		</synopsis>
+		<syntax>
+			<parameter name="field" required="true">
+				<para>The following fields are available for retrieval:</para>
+				<enumlist>
+					<enum name="reason">
+						<para>INVALID, ERROR, RESPONSETIMEOUT, ABSOLUTETIMEOUT, or custom
+						value set by the RaiseException() application</para>
+					</enum>
+					<enum name="context">
+						<para>The context executing when the exception occurred.</para>
+					</enum>
+					<enum name="exten">
+						<para>The extension executing when the exception occurred.</para>
+					</enum>
+					<enum name="priority">
+						<para>The numeric priority executing when the exception occurred.</para>
+					</enum>
+				</enumlist>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Retrieve the details (specified <replaceable>field</replaceable>) of the current dialplan exception.</para>
+		</description>
+	</function>
  ***/
 
 #ifdef LOW_MEMORY
@@ -2878,15 +2906,6 @@
 
 static struct ast_custom_function exception_function = {
 	.name = "EXCEPTION",
-	.synopsis = "Retrieve the details of the current dialplan exception",
-	.desc =
-"The following fields are available for retrieval:\n"
-"  reason    INVALID, ERROR, RESPONSETIMEOUT, ABSOLUTETIMEOUT, or custom\n"
-"               value set by the RaiseException() application\n"
-"  context   The context executing when the exception occurred\n"
-"  exten     The extension executing when the exception occurred\n"
-"  priority  The numeric priority executing when the exception occurred\n",
-	.syntax = "EXCEPTION(<field>)",
 	.read = acf_exception_read,
 };