[asterisk-dev] Appdoc for manager events

[Fredrik Liljegren]

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>

What do you think?


(Then I guess there should be some structuring/documentation of what
manager event classes should be used, more than the comments in
manager.h...)

/Fredrik (fiddur @ irc)