changeset 30871:d91e3a6c4a91

Clarify documentation on a function return value.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Tue, 24 Aug 2010 04:42:41 +0000
parents afc1460bdb43
children 1feb2baeac2d
files libpurple/media/codec.h
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/media/codec.h	Mon Aug 23 05:22:58 2010 +0000
+++ b/libpurple/media/codec.h	Tue Aug 24 04:42:41 2010 +0000
@@ -121,7 +121,8 @@
  *
  * @param The codec to get the optional parameters from.
  *
- * @return The list of optional parameters.
+ * @return The list of optional parameters. The list is owned by the codec and
+ *         should not be freed.
  *
  * @since 2.6.0
  */