[asterisk-commits] file: branch file/bridging r163106 - /team/file/bridging/apps/app_confbridge.c

[SVN commits to the Asterisk project]

Author: file
Date: Thu Dec 11 11:17:52 2008
New Revision: 163106

URL: http://svn.digium.com/view/asterisk?view=rev&rev=163106
Log:
Update to using XML documentation.

Modified:
    team/file/bridging/apps/app_confbridge.c

Modified: team/file/bridging/apps/app_confbridge.c
URL: http://svn.digium.com/view/asterisk/team/file/bridging/apps/app_confbridge.c?view=diff&rev=163106&r1=163105&r2=163106
==============================================================================
--- team/file/bridging/apps/app_confbridge.c (original)
+++ team/file/bridging/apps/app_confbridge.c Thu Dec 11 11:17:52 2008
@@ -49,6 +49,58 @@
 #include "asterisk/audiohook.h"
 #include "asterisk/astobj2.h"
 
+/*** DOCUMENTATION
+        <application name="ConfBridge" language="en_US">
+                <synopsis>
+                        Conference bridge application.
+                </synopsis>
+                <syntax>
+                        <parameter name="confno">
+                                <para>The conference number</para>
+                        </parameter>
+                        <parameter name="options">
+                                <optionlist>
+                                        <option name="a">
+                                                <para>Set admin mode.</para>
+                                        </option>
+                                        <option name="A">
+                                                <para>Set marked mode.</para>
+                                        </option>
+                                        <option name="c">
+                                                <para>Announce user(s) count on joining a conference.</para>
+                                        </option>
+                                        <option name="m">
+                                                <para>Set initially muted.</para>
+                                        </option>
+                                        <option name="M" hasparams="optional">
+                                                <para>Enable music on hold when the conference has a single caller. Optionally,
+                                                specify a musiconhold class to use. If one is not provided, it will use the
+                                                channel's currently set music class, or <literal>default</literal>.</para>
+                                                <argument name="class" required="true" />
+                                        </option>
+                                        <option name="1">
+                                                <para>Do not play message when first person enters</para>
+                                        </option>
+                                        <option name="s">
+                                                <para>Present menu (user or admin) when <literal>*</literal> is received
+                                                (send to menu).</para>
+                                        </option>
+                                        <option name="w">
+                                                <para>Wait until the marked user enters the conference.</para>
+                                        </option>
+                                        <option name="q">
+                                                <para>Quiet mode (don't play enter/leave sounds).</para>
+                                        </option>
+				</optionlist>
+		      </parameter> 
+                </syntax>
+                <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>
+                </description>
+        </application>
+***/
+
 /*!
  * \par Playing back a file to a channel in a conference
  * You might notice in this application that while playing a sound file
@@ -60,26 +112,6 @@
  */
 
 static char *app = "ConfBridge";
-static char *synopsis = 
-"Conference Bridge application.";
-static char *descrip =
-"  ConfBridge([confno][,[options]]): Enters the user into a specified conference bridge.\n"
-"The option string may contain zero or more of the following characters:\n"
-"      'A' -- Set marked mode\n"
-"      'a' -- Set admin mode\n"
-"      'c' -- Announce user(s) count on joining a conference\n"
-"      'm' -- Present menu (user or admin) when '#' is received\n"
-"      'M[(<class>)]'\n"
-"          -- Enable music on hold when the conference has a single caller.\n"
-"             Optionally, specify a musiconhold class to use.  If one is not\n"
-"             provided, it will use the channel's currently set music class,\n"
-"             or \"default\".\n"
-"      'l' -- Do not play message when first person enters\n"
-"      's' -- Set initially muted\n"
-"      'w' -- Wait until a marked user enters before starting the conference\n"
-"      'q' -- Do not play audio prompts\n"
-"The join sound can be set using the CONFBRIDGE_JOIN_SOUND variable and the leave sound\n"
-"can be set using the CONFBRIDGE_LEAVE_SOUND variable. These can be unique to the caller.";
 
 enum {
 	OPTION_ADMIN = (1 << 0),             /*!< Set if the caller is an administrator */
@@ -719,7 +751,7 @@
 		return AST_MODULE_LOAD_DECLINE;
 	}
 
-	if (ast_register_application(app, confbridge_exec, synopsis, descrip)) {
+	if (ast_register_application_xml(app, confbridge_exec)) {
 		ao2_ref(conference_bridges, -1);
 		return AST_MODULE_LOAD_DECLINE;
 	}