Add AMI event documentation
authorMatthew Jordan <mjordan@digium.com>
Mon, 25 Jun 2012 17:59:34 +0000 (17:59 +0000)
committerMatthew Jordan <mjordan@digium.com>
Mon, 25 Jun 2012 17:59:34 +0000 (17:59 +0000)
commit82a7409c15cf943ebc12cc8453424350628732bf
treefd06e7c2248dae47e019c76bef0b4865c284e00d
parentd0fda07d74b0e73ea563e3b90361faf5f20965e3
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
19 files changed:
CHANGES
Makefile
apps/app_chanspy.c
apps/app_confbridge.c
apps/app_dial.c
apps/app_meetme.c
apps/app_queue.c
apps/app_stack.c
apps/app_userevent.c
apps/app_voicemail.c
build_tools/get_documentation.py [new file with mode: 0644]
build_tools/post_process_documentation.py [new file with mode: 0644]
configure
configure.ac
doc/appdocsxml.dtd
include/asterisk/xmldoc.h
main/manager.c
main/xmldoc.c
makeopts.in