Add AMI event documentation
This patch adds the core changes necessary to support AMI event documentation in the source files of Asterisk, and adds documentation to those AMI events defined in the core application modules. Event documentation is built from the source by two new python scripts, located in build_tools: get_documentation.py and post_process_documentation.py. The get_documentation.py script mirrors the actions of the existing AWK get_documentation scripts, except that it will scan the entirety of a source file for Asterisk documentation. Upon encountering it, if the documentation happens to be an AMI event, it will attempt to extract information about the event directly from the manager event macro calls that raise the event. The post_process_documentation.py script combines manager event instances that are the same event but documented in multiple source files. It generates the final core-[lang].xml file. As this process can take longer to complete than a typical 'make all', it is only performed if a new make target, 'full', is chosen. Review: https://reviewboard.asterisk.org/r/1967/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369346 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Showing
- CHANGES 15 additions, 0 deletionsCHANGES
- Makefile 40 additions, 0 deletionsMakefile
- apps/app_chanspy.c 18 additions, 0 deletionsapps/app_chanspy.c
- apps/app_confbridge.c 62 additions, 0 deletionsapps/app_confbridge.c
- apps/app_dial.c 24 additions, 0 deletionsapps/app_dial.c
- apps/app_meetme.c 101 additions, 4 deletionsapps/app_meetme.c
- apps/app_queue.c 289 additions, 4 deletionsapps/app_queue.c
- apps/app_stack.c 8 additions, 0 deletionsapps/app_stack.c
- apps/app_userevent.c 11 additions, 0 deletionsapps/app_userevent.c
- apps/app_voicemail.c 29 additions, 1 deletionapps/app_voicemail.c
- build_tools/get_documentation.py 175 additions, 0 deletionsbuild_tools/get_documentation.py
- build_tools/post_process_documentation.py 105 additions, 0 deletionsbuild_tools/post_process_documentation.py
- configure 537 additions, 527 deletionsconfigure
- configure.ac 1 addition, 0 deletionsconfigure.ac
- doc/appdocsxml.dtd 9 additions, 2 deletionsdoc/appdocsxml.dtd
- include/asterisk/xmldoc.h 46 additions, 0 deletionsinclude/asterisk/xmldoc.h
- main/manager.c 185 additions, 0 deletionsmain/manager.c
- main/xmldoc.c 399 additions, 75 deletionsmain/xmldoc.c
- makeopts.in 1 addition, 0 deletionsmakeopts.in
Loading
Please register or sign in to comment