[asterisk-commits] file: branch group/media_formats r406913 - /team/group/media_formats/include/...

[SVN commits to the Asterisk project]

Author: file
Date: Wed Jan 29 10:23:54 2014
New Revision: 406913

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=406913
Log:
Add some notes to operations which return an immutable format.

Modified:
    team/group/media_formats/include/asterisk/format_ng.h

Modified: team/group/media_formats/include/asterisk/format_ng.h
URL: http://svnview.digium.com/svn/asterisk/team/group/media_formats/include/asterisk/format_ng.h?view=diff&rev=406913&r1=406912&r2=406913
==============================================================================
--- team/group/media_formats/include/asterisk/format_ng.h (original)
+++ team/group/media_formats/include/asterisk/format_ng.h Wed Jan 29 10:23:54 2014
@@ -131,11 +131,15 @@
  *
  * \retval non-NULL if joint capability exists
  * \retval NULL if no joint capability exists
+ *
+ * \note The returned format must be treated as immutable.
  */
 struct ast_format *ast_format_ng_joint(const struct ast_format *format1, const struct ast_format *format2);
 
 /*!
  * \brief Copy a media format
+ *
+ * \note The returned format must be treated as immutable.
  */
 struct ast_format *ast_format_ng_copy(struct ast_format *format);