diff options
| author | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
| commit | 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_alarmreceiver.c | |
| parent | 1fef0f63bbbde9530837995c8790b839f73b74e7 (diff) | |
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the
interfaces in Asterisk in an XML format. Currently, a new format is available for
applications and dialplan functions. A good number of conversions to the new format
are also included.
For more information, see the following message to asterisk-dev:
http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_alarmreceiver.c')
| -rw-r--r-- | apps/app_alarmreceiver.c | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/apps/app_alarmreceiver.c b/apps/app_alarmreceiver.c index db76bbdb7..12ae49d65 100644 --- a/apps/app_alarmreceiver.c +++ b/apps/app_alarmreceiver.c @@ -63,18 +63,21 @@ struct event_node{ typedef struct event_node event_node_t; static char *app = "AlarmReceiver"; - -static char *synopsis = "Provide support for receiving alarm reports from a burglar or fire alarm panel"; -static char *descrip = -" AlarmReceiver(): Only 1 signalling format is supported at this time: Ademco\n" -"Contact ID. This application should be called whenever there is an alarm\n" -"panel calling in to dump its events. The application will handshake with the\n" -"alarm panel, and receive events, validate them, handshake them, and store them\n" -"until the panel hangs up. Once the panel hangs up, the application will run the\n" -"system command specified by the eventcmd setting in alarmreceiver.conf and pipe\n" -"the events to the standard input of the application. The configuration file also\n" -"contains settings for DTMF timing, and for the loudness of the acknowledgement\n" -"tones.\n"; +/*** DOCUMENTATION + <application name="AlarmReceiver" language="en_US"> + <synopsis> + Provide support for receiving alarm reports from a burglar or fire alarm panel + </synopsis> + <syntax /> + <description> + <para>This application should be called whenever there is an alarm panel calling in to dump its events. + The application will handshake with the alarm panel, and receive events, validate them, handshake them, and store them until the panel hangs up. + Once the panel hangs up, the application will run the system command specified by the eventcmd setting in <filename>alarmreceiver.conf</filename> and pipe the events to the standard input of the application. + The configuration file also contains settings for DTMF timing, and for the loudness of the acknowledgement tones.</para> + <note><para>Only 1 signalling format is supported at this time: Ademco Contact ID.</para></note> + </description> + </application> + ***/ /* Config Variables */ static int fdtimeout = 2000; @@ -711,7 +714,7 @@ static int unload_module(void) static int load_module(void) { if (load_config()) { - if (ast_register_application(app, alarmreceiver_exec, synopsis, descrip)) + if (ast_register_application_xml(app, alarmreceiver_exec)) return AST_MODULE_LOAD_FAILURE; return AST_MODULE_LOAD_SUCCESS; } else |