[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/#review12768
-----------------------------------------------------------



trunk/include/asterisk/manager.h
<https://reviewboard.asterisk.org/r/3812/#comment23080>

    I'd say remove 'Possible'.  There should always be a single final_response if the response is documented - unless I'm misreading this is enforced by XML schema.  Also s/events/event/.



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23157>

    Moving your new procedures later in the file can probably avoid this forward declaration.  If not it should be moved toward the top of the file.



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23158>

    Tab between param name and description?



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23160>

    _ast_ prefix is listed in main/asterisk.exports so it should not be used for static procedures.  I think xmldoc_build_list_responses would be good.



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23156>

    This seems to break the guideline of not doing adhoc list code.  If this can be fixed without much trouble please do so.  I suspect this is due to the way that ast_xml_doc_item is written in which case you can ignore this comment.



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23159>

    Tab between parameter name and description?



trunk/main/xmldoc.c
<https://reviewboard.asterisk.org/r/3812/#comment23161>

    Please remove _ast_ prefix.


- Corey Farrell


On July 18, 2014, 3:57 p.m., opticron wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/3812/
> -----------------------------------------------------------
> 
> (Updated July 18, 2014, 3:57 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 418964 
>   trunk/main/manager_bridges.c 418964 
>   trunk/main/manager.c 418964 
>   trunk/include/asterisk/xmldoc.h 418964 
>   trunk/include/asterisk/manager.h 418964 
>   trunk/doc/appdocsxml.dtd 418964 
> 
> 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/20140722/e481d71b/attachment-0001.html>