[asterisk-dev] [Code Review] 3812: AMI: Allow for response documentation

[Corey Farrell]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3812/#review12718
-----------------------------------------------------------



trunk/doc/appdocsxml.dtd
<https://reviewboard.asterisk.org/r/3812/#comment23011>

    I'd prefer to see a new xml tag for responses instead of managerEvent.  The BridgeInfo responses are actually a good example of why.  This should allow us to document the fact that BridgeInfoChannel is a list item, and BridgeInfoComplete is the final packet / end of list.  I'm sure we'll find other reasons to have different attributes/tags within action responses vs managerEvent, but list responses are the big reason I can think of.  I'm sure there will be similarities, but that's what ATTLIST is for.


- Corey Farrell


On July 16, 2014, 5:16 p.m., opticron wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/3812/
> -----------------------------------------------------------
> 
> (Updated July 16, 2014, 5:16 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> Allow for responses to AMI actions/commands to be documented properly in XML and displayed via the CLI. Response events are documented exactly as standard AMI events are documented.
> 
> 
> Diffs
> -----
> 
>   trunk/main/xmldoc.c 418779 
>   trunk/main/manager_bridges.c 418779 
>   trunk/main/manager.c 418779 
>   trunk/include/asterisk/xmldoc.h 418779 
>   trunk/include/asterisk/manager.h 418779 
>   trunk/doc/appdocsxml.dtd 418779 
> 
> Diff: https://reviewboard.asterisk.org/r/3812/diff/
> 
> 
> Testing
> -------
> 
> The BridgeInfo AMI command was documented and tested as an example.
> 
> 
> Thanks,
> 
> opticron
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20140717/49887af8/attachment.html>