[FFmpeg-cvslog] r24771 - trunk/libavformat/avformat.h

[stefano]

Author: stefano
Date: Wed Aug 11 16:38:19 2010
New Revision: 24771

Log:
Add documentation for the pm parameter of the av_metadata_set*
functions.

Modified:
   trunk/libavformat/avformat.h

Modified: trunk/libavformat/avformat.h
==============================================================================
--- trunk/libavformat/avformat.h	Wed Aug 11 16:38:16 2010	(r24770)
+++ trunk/libavformat/avformat.h	Wed Aug 11 16:38:19 2010	(r24771)
@@ -144,6 +144,8 @@ av_metadata_get(AVMetadata *m, const cha
 /**
  * Set the given tag in *pm, overwriting an existing tag.
  *
+ * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
+ * a metadata struct is allocated and put in *pm.
  * @param key tag key to add to *pm (will be av_strduped)
  * @param value tag value to add to *pm (will be av_strduped)
  * @return >= 0 on success otherwise an error code <0
@@ -155,6 +157,8 @@ attribute_deprecated int av_metadata_set
 /**
  * Set the given tag in *pm, overwriting an existing tag.
  *
+ * @param pm pointer to a pointer to a metadata struct. If *pm is NULL
+ * a metadata struct is allocated and put in *pm.
  * @param key tag key to add to *pm (will be av_strduped depending on flags)
  * @param value tag value to add to *pm (will be av_strduped depending on flags).
  *        Passing a NULL value will cause an existing tag to be deleted.