[asterisk-commits] mmichelson: branch mmichelson/transfer_stasis r392727 - /team/mmichelson/tran...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Mon Jun 24 13:08:13 2013
New Revision: 392727

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=392727
Log:
Adjust some documentation for manager events.


Modified:
    team/mmichelson/transfer_stasis/main/stasis_bridging.c

Modified: team/mmichelson/transfer_stasis/main/stasis_bridging.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/transfer_stasis/main/stasis_bridging.c?view=diff&rev=392727&r1=392726&r2=392727
==============================================================================
--- team/mmichelson/transfer_stasis/main/stasis_bridging.c (original)
+++ team/mmichelson/transfer_stasis/main/stasis_bridging.c Mon Jun 24 13:08:13 2013
@@ -162,9 +162,11 @@
 				</parameter>
 				<parameter name="BridgeUniqueidOrig">
 					<para>The ID of the bridge where the Transferer performed the transfer</para>
+					<note><para>This header will not be present if the original transferer was not in a bridge.</para></note>
 				</parameter>
 				<parameter name="BridgeTypeOrig">
 					<para>The type of the bridge where the Transferer performed the transfer</para>
+					<note><para>This header will not be present if the original transferer was not in a bridge.</para></note>
 				</parameter>
 				<parameter name="SecondTransfererChannel">
 					<para>The second transferer channel involved in the attended transfer.</para>
@@ -207,9 +209,11 @@
 				</parameter>
 				<parameter name="BridgeUniqueidSecond">
 					<para>The unique ID of the bridge that the second transferer channel was in, or <literal>None</literal> if the second transferer channel was not bridged</para>
+					<note><para>This header will not be present if the second transferer was not in a bridge.</para></note>
 				</parameter>
 				<parameter name="BridgeTypeSecond">
 					<para>The type of the bridge where the Transferer performed the transfer</para>
+					<note><para>This header will not be present if the second transferer was not in a bridge.</para></note>
 				</parameter>
 				<parameter name="DestType">
 					<para>Indicates the method by which the attended transfer completed.</para>
@@ -337,11 +341,11 @@
 				<para>	<replaceable>OrigTransfererChannel</replaceable>: Alice's channel in the bridge with Bob.</para>
 				<para>	<replaceable>BridgeUniqueidOrig</replaceable>: The bridge between Alice and Bob.</para>
 				<para>	<replaceable>SecondTransfererChannel</replaceable>: Alice's channel that called Voicemail.</para>
-				<para>	<replaceable>BridgeUniqueidSecond</replaceable>: None, since a call to Voicemail has no bridge.</para>
+				<para>	<replaceable>BridgeUniqueidSecond</replaceable>: Not present, since a call to Voicemail has no bridge.</para>
 				<para>Now consider if the order were reversed; instead of having Alice call Bob and transfer him to Voicemail, Alice instead
 				calls her Voicemail and transfers that to Bob. The transferer and bridge headers would be arranged as follows:</para>
 				<para>	<replaceable>OrigTransfererChannel</replaceable>: Alice's channel that called Voicemail.</para>
-				<para>	<replaceable>BridgeUniqueidOrig</replaceable>: None, since a call to Voicemail has no bridge.</para>
+				<para>	<replaceable>BridgeUniqueidOrig</replaceable>: Not present, since a call to Voicemail has no bridge.</para>
 				<para>	<replaceable>SecondTransfererChannel</replaceable>: Alice's channel in the bridge with Bob.</para>
 				<para>	<replaceable>BridgeUniqueidSecond</replaceable>: The bridge between Alice and Bob.</para>
 			</description>