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

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Jun 12 11:11:57 2013
New Revision: 391549

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391549
Log:
Clear up doxygen remarks about is_external parameters.


Modified:
    team/mmichelson/transfer_stasis/include/asterisk/stasis_bridging.h

Modified: team/mmichelson/transfer_stasis/include/asterisk/stasis_bridging.h
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/transfer_stasis/include/asterisk/stasis_bridging.h?view=diff&rev=391549&r1=391548&r2=391549
==============================================================================
--- team/mmichelson/transfer_stasis/include/asterisk/stasis_bridging.h (original)
+++ team/mmichelson/transfer_stasis/include/asterisk/stasis_bridging.h Wed Jun 12 11:11:57 2013
@@ -235,7 +235,7 @@
 	);
 	/*! Result of the blind transfer */
 	enum ast_transfer_result result;
-	/*! If 0, was core DTMF transfer, otherwise was a native transfer */
+	/*! If 0, was core DTMF transfer, otherwise occurred externally*/
 	int is_external;
 	/*! The transferer and its bridge before starting the transfer*/
 	struct ast_bridge_channel_snapshot_pair transferer;
@@ -252,7 +252,7 @@
 /*!
  * \brief Publish a blind transfer event
  *
- * \param is_external Whether the blind transfer is a native blind transfer
+ * \param is_external Whether the blind transfer was initiated externally (e.g. via AMI or native protocol)
  * \param result The success or failure of the transfer
  * \param to_transferee The bridge between the transferer and transferee plus the transferer channel
  * \param context The destination context for the blind transfer
@@ -278,7 +278,7 @@
 struct ast_attended_transfer_message {
 	/*! Result of the blind transfer */
 	enum ast_transfer_result result;
-	/*! Indicates if the transfer was performed using a native protocol */
+	/*! Indicates if the transfer was initiated externally*/
 	int is_external;
 	/*! Bridge between transferer <-> transferee and the transferer channel in that bridge. May be NULL */
 	struct ast_bridge_channel_snapshot_pair to_transferee;
@@ -316,7 +316,7 @@
  * Publish an \ref ast_attended_transfer_message with the dest_type set to
  * \c AST_ATTENDED_TRANSFER_DEST_FAIL.
  *
- * \param is_external Indicates if the transfer was performed natively
+ * \param is_external Indicates if the transfer was initiated externally
  * \param result The result of the transfer. Will always be a type of failure.
  * \param transferee The bridge between the transferer and transferees as well as the transferer channel from that bridge
  * \param target The bridge between the transferer and transfer targets as well as the transferer channel from that bridge
@@ -337,7 +337,7 @@
  *
  * In either case, two bridges enter, one leaves.
  *
- * \param is_external Indicates if the transfer was performed natively
+ * \param is_external Indicates if the transfer was initiated externally
  * \param result The result of the transfer. Will always be a type of failure.
  * \param transferee The bridge between the transferer and transferees as well as the transferer channel from that bridge
  * \param target The bridge between the transferer and transfer targets as well as the transferer channel from that bridge
@@ -358,7 +358,7 @@
  * \li A transferee channel leaving a bridge to run an app
  * \li A bridge of transferees running an app (via a local channel)
  *
- * \param is_external Indicates if the transfer was performed natively
+ * \param is_external Indicates if the transfer was initiated externally
  * \param result The result of the transfer. Will always be a type of failure.
  * \param transferee The bridge between the transferer and transferees as well as the transferer channel from that bridge
  * \param target The bridge between the transferer and transfer targets as well as the transferer channel from that bridge
@@ -381,7 +381,7 @@
  * When this type of transfer occurs, the two bridges continue to exist after the
  * transfer and a local channel is used to link the two bridges together.
  *
- * \param is_external Indicates if the transfer was performed natively
+ * \param is_external Indicates if the transfer was initiated externally
  * \param result The result of the transfer. Will always be a type of failure.
  * \param transferee The bridge between the transferer and transferees as well as the transferer channel from that bridge
  * \param target The bridge between the transferer and transfer targets as well as the transferer channel from that bridge