various doxygen fixes

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@26170 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 7 insertions, 0 deletions

diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h
index 770f8ce14..00001f059 100644
--- a/include/asterisk/channel.h
+++ b/include/asterisk/channel.h
@@ -625,6 +625,13 @@ int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type cont
   The supplied payload data is copied into the frame, so the caller's copy
   is not modified nor freed, and the resulting frame will retain a copy of
   the data even if the caller frees their local copy.
+
+  \note This method should be treated as a 'network transport'; in other
+  words, your frames may be transferred across an IAX2 channel to another
+  system, which may be a different endianness than yours. Because of this,
+  you should ensure that either your frames will never be expected to work
+  across systems, or that you always put your payload data into 'network byte
+  order' before calling this function.
 */
 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
 			   const void *data, size_t datalen);