Merged revisions 176697 via svnmerge from

https://origsvn.digium.com/svn/asterisk/trunk

........
  r176697 | mmichelson | 2009-02-17 15:40:09 -0600 (Tue, 17 Feb 2009) | 3 lines
  
  Clear up documentation of AST_FRIENDLY_OFFSET in frame.h
........


git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.0@176698 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 11 insertions, 3 deletions

diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h
index 9e4b527d8..892a531b6 100644
--- a/include/asterisk/frame.h
+++ b/include/asterisk/frame.h
@@ -194,9 +194,17 @@ struct ast_frame {
     for this purpose instead of having to declare one on the stack */
 extern struct ast_frame ast_null_frame;
 
-#define AST_FRIENDLY_OFFSET 	64	/*! It's polite for a a new frame to
-					  have this number of bytes for additional
-					  headers.  */
+/*! \brief Offset into a frame's data buffer.
+ *
+ * By providing some "empty" space prior to the actual data of an ast_frame,
+ * this gives any consumer of the frame ample space to prepend other necessary
+ * information without having to create a new buffer.
+ *
+ * As an example, RTP can use the data from an ast_frame and simply prepend the
+ * RTP header information into the space provided by AST_FRIENDLY_OFFSET instead
+ * of having to create a new buffer with the necessary space allocated.
+ */
+#define AST_FRIENDLY_OFFSET 	64	
 #define AST_MIN_OFFSET 		32	/*! Make sure we keep at least this much handy */
 
 /*! Need the header be free'd? */