[asterisk-bugs] [Asterisk 0017173]: Appdoc for manager events

[Asterisk Bug Tracker]

The following issue has been SUBMITTED. 
====================================================================== 
https://issues.asterisk.org/view.php?id=17173 
====================================================================== 
Reported By:                fiddur
Assigned To:                
====================================================================== 
Project:                    Asterisk
Issue ID:                   17173
Category:                   Documentation
Reproducibility:            N/A
Severity:                   feature
Priority:                   normal
Status:                     new
Asterisk Version:           SVN 
JIRA:                        
Regression:                 No 
Reviewboard Link:            
SVN Branch (only for SVN checkouts, not tarball releases):  trunk 
SVN Revision (number only!): 257023 
Request Review:              
====================================================================== 
Date Submitted:             2010-04-13 01:52 CDT
Last Modified:              2010-04-13 01:52 CDT
====================================================================== 
Summary:                    Appdoc for manager events
Description: 
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>


====================================================================== 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2010-04-13 01:52 fiddur         New Issue                                    
2010-04-13 01:52 fiddur         Asterisk Version          => SVN             
2010-04-13 01:52 fiddur         Regression                => No              
2010-04-13 01:52 fiddur         SVN Branch (only for SVN checkouts, not tarball
releases) =>  trunk          
2010-04-13 01:52 fiddur         SVN Revision (number only!) => 257023          
======================================================================