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

[Asterisk Bug Tracker]

A NOTE has been added to this issue. 
====================================================================== 
https://issues.asterisk.org/view.php?id=17173 
====================================================================== 
Reported By:                fiddur
Assigned To:                
====================================================================== 
Project:                    Asterisk
Issue ID:                   17173
Category:                   Core/NewFeature
Reproducibility:            N/A
Severity:                   feature
Priority:                   normal
Status:                     feedback
Asterisk Version:           SVN 
JIRA:                       SWP-1286 
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-14 08:09 CDT
====================================================================== 
Summary:                    [patch] 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>


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

---------------------------------------------------------------------- 
 (0120380) eliel (manager) - 2010-04-14 08:09
 https://issues.asterisk.org/view.php?id=17173#c120380 
---------------------------------------------------------------------- 
you have in main/xmldoc.c all the source code that supports the xml
documentation.

You will need to add in xmldoc.c all the functions to support this new
kind of documentation.

Add a CLI command like:
         "manager show event <event name>"  and "manager show events"  to
show the documentation. 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2010-04-14 08:09 eliel          Note Added: 0120380                          
======================================================================