[asterisk-bugs] [JIRA] Closed: (ASTERISK-15949) [branch] Appdoc for manager events

[Matt Jordan (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-15949?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Matt Jordan closed ASTERISK-15949.
----------------------------------

                  Resolution: Fixed
    Target Release Version/s: 11.0.0-beta1

Manager Event documentation has been added to Asterisk 11.  A slightly different schema for manager events was used than what is proposed on this issue here.  For more information, please see:

https://wiki.asterisk.org/wiki/display/AST/AMI+Event+Documentation

> [branch] Appdoc for manager events
> ----------------------------------
>
>                 Key: ASTERISK-15949
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-15949
>             Project: Asterisk
>          Issue Type: New Feature
>          Components: Core/NewFeature
>            Reporter: Fredrik Liljegren
>             Fix For: 11.0.0-beta1
>
>         Attachments: 257023.diff
>
>
> Hi.
> I recently added a manager event, and wanted to document it, only to
> find (or rather NOT find) there's no documentation praxis for manager
> events.
> I propose adding an appdoc element type for events.
> Something like:
>   <!ELEMENT ami_event (synopsis?,description?,see-also?)>
>   <!ATTLIST ami_event name CDATA #REQUIRED>
>   <!ATTLIST ami_event class CDATA #REQUIRED>
>   <!ATTLIST ami_event language CDATA #REQUIRED>
> Example:
> <ami_event name="MusicOnHold" class="CALL" language="en_US">
>   <synopsis>
>     Occurs when a channel is placed on hold/unhold and music is played
> to the caller.
>   </synopsis>
>   <description>
>     <para>Triggered when music on hold starts or stops on a channel.</para>
>     <variablelist>
>       <variable name="Channel">
>         <para>Channel ID</para>
>       </variable>
>       <variable name="State">
>         <value name="Start" />
>         <value name="Stop" />
>       </variable>
>       <variable name="Uniqueid">
>         <para>Unique ID</para>
>       </variable>
>     </variablelist>
>   </description>
>   <see-also>
>     <ref type="application">MusicOnHold</ref>
>   </see-also>
> </ami_event>
> ****** ADDITIONAL INFORMATION ******
> I posted this suggestion on asterisk-dev list a whila ago, but didn't get any comments on format, just a few positive remarks on irc that it would be good to have the documentation for events.
> Branch available here: http://svn.digium.com/svn/asterisk/team/pabelanger/issue17173/

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira