[asterisk-commits] rmudgett: branch rmudgett/hangup_handlers r369385 - /team/rmudgett/hangup_han...

[SVN commits to the Asterisk project]

Author: rmudgett
Date: Mon Jun 25 15:40:16 2012
New Revision: 369385

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=369385
Log:
Add AMI event XML documentation.

Modified:
    team/rmudgett/hangup_handlers/main/pbx.c

Modified: team/rmudgett/hangup_handlers/main/pbx.c
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/hangup_handlers/main/pbx.c?view=diff&rev=369385&r1=369384&r2=369385
==============================================================================
--- team/rmudgett/hangup_handlers/main/pbx.c (original)
+++ team/rmudgett/hangup_handlers/main/pbx.c Mon Jun 25 15:40:16 2012
@@ -5433,6 +5433,16 @@
 			break;
 		}
 
+		/*** DOCUMENTATION
+			<managerEventInstance>
+				<synopsis>Raised when a hangup handler is about to be called.</synopsis>
+				<syntax>
+					<parameter name="Handler">
+						<para>Hangup handler parameter string passed to the Gosub application.</para>
+					</parameter>
+				</syntax>
+			</managerEventInstance>
+		***/
 		manager_event(EVENT_FLAG_DIALPLAN, "HangupHandlerRun",
 			"Channel: %s\r\n"
 			"Uniqueid: %s\r\n"
@@ -5483,6 +5493,23 @@
 	handlers = ast_channel_hangup_handlers(chan);
 	h_handler = AST_LIST_REMOVE_HEAD(handlers, node);
 	if (h_handler) {
+		/*** DOCUMENTATION
+			<managerEventInstance>
+				<synopsis>
+					Raised when a hangup handler is removed from the handler
+					stack by the CHANNEL() function.
+				</synopsis>
+				<syntax>
+					<parameter name="Handler">
+						<para>Hangup handler parameter string passed to the Gosub application.</para>
+					</parameter>
+				</syntax>
+				<see-also>
+					<ref type="managerEvent">HangupHandlerPush</ref>
+					<ref type="function">CHANNEL</ref>
+				</see-also>
+			</managerEventInstance>
+		***/
 		manager_event(EVENT_FLAG_DIALPLAN, "HangupHandlerPop",
 			"Channel: %s\r\n"
 			"Uniqueid: %s\r\n"
@@ -5526,6 +5553,23 @@
 	handlers = ast_channel_hangup_handlers(chan);
 	AST_LIST_INSERT_HEAD(handlers, h_handler, node);
 
+	/*** DOCUMENTATION
+		<managerEventInstance>
+			<synopsis>
+				Raised when a hangup handler is added to the handler
+				stack by the CHANNEL() function.
+			</synopsis>
+			<syntax>
+				<parameter name="Handler">
+					<para>Hangup handler parameter string passed to the Gosub application.</para>
+				</parameter>
+			</syntax>
+			<see-also>
+				<ref type="managerEvent">HangupHandlerPop</ref>
+				<ref type="function">CHANNEL</ref>
+			</see-also>
+		</managerEventInstance>
+	***/
 	manager_event(EVENT_FLAG_DIALPLAN, "HangupHandlerPush",
 		"Channel: %s\r\n"
 		"Uniqueid: %s\r\n"