summaryrefslogtreecommitdiff
path: root/libavformat
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2010-08-11 14:38:19 +0000
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2010-08-11 14:38:19 +0000
commit983ec304974bfa928735153e115659c700c170dd (patch)
treef7f2f5f2665b14440af467e9f5104ae49938d548 /libavformat
parent32e6f246b3879280b239a692aa6d11a2d7104614 (diff)
Add documentation for the pm parameter of the av_metadata_set*
functions. Originally committed as revision 24771 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavformat')
-rw-r--r--libavformat/avformat.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 0c702799c2..7514075d53 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -144,6 +144,8 @@ av_metadata_get(AVMetadata *m, const char *key, const AVMetadataTag *prev, int f
/**
* 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(AVMetadata **pm, const char *key, const
/**
* 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.