diff options
| author | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2012-07-10 22:26:27 +0000 |
| commit | 2ffae5745d6d68f1599f4dfbf0ead131cf5acc32 (patch) | |
| tree | 1304cf10595e850a33e2dbb2458a2819751bc1ce /channels/sig_analog.c | |
| parent | 3805e2ae4d654a24f7c98fc6f41dcec81d02670e (diff) | |
Add some additional documentation for core AMI events
This patch adds some basic documentation for a number of modules. This
includes core source files in Asterisk (those in main), as well as
chan_agent, chan_dahdi, chan_local, sig_analog, and sig_pri. The DTD
has also been updated to allow referencing of AMI commands.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369905 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'channels/sig_analog.c')
| -rw-r--r-- | channels/sig_analog.c | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/channels/sig_analog.c b/channels/sig_analog.c index cf51e9727..e84bbc6f8 100644 --- a/channels/sig_analog.c +++ b/channels/sig_analog.c @@ -3138,6 +3138,11 @@ static struct ast_frame *__analog_handle_event(struct analog_pvt *p, struct ast_ case ANALOG_EVENT_NOALARM: analog_set_alarm(p, 0); ast_log(LOG_NOTICE, "Alarm cleared on channel %d\n", p->channel); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when an Alarm is cleared on an Analog channel.</synopsis> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "AlarmClear", "Channel: %d\r\n", p->channel); break; @@ -4013,6 +4018,19 @@ int analog_dnd(struct analog_pvt *p, int flag) ast_verb(3, "%s DND on channel %d\n", flag ? "Enabled" : "Disabled", p->channel); + /*** DOCUMENTATION + <managerEventInstance> + <synopsis>Raised when the Do Not Disturb state is changed on an Analog channel.</synopsis> + <syntax> + <parameter name="Status"> + <enumlist> + <enum name="enabled"/> + <enum name="disabled"/> + </enumlist> + </parameter> + </syntax> + </managerEventInstance> + ***/ manager_event(EVENT_FLAG_SYSTEM, "DNDState", "Channel: DAHDI/%d\r\n" "Status: %s\r\n", p->channel, |