[FFmpeg-cvslog] lavu/dict.h: extend/clarify docs for av_dict_parse_string()

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Wed Nov 20 15:28:17 2013 +0100| [e782eea183ba3c03f5179ac83f85e25ae9c1290f] | committer: Stefano Sabatini

lavu/dict.h: extend/clarify docs for av_dict_parse_string()

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=e782eea183ba3c03f5179ac83f85e25ae9c1290f
---

 libavutil/dict.h |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/libavutil/dict.h b/libavutil/dict.h
index 5d66bb7..1dfc5a6 100644
--- a/libavutil/dict.h
+++ b/libavutil/dict.h
@@ -118,7 +118,10 @@ int av_dict_count(const AVDictionary *m);
 int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags);
 
 /**
- * Parse the key/value pairs list and add to a dictionary.
+ * Parse the key/value pairs list and add the parsed entries to a dictionary.
+ *
+ * In case of failure, all the successfully set entries are stored in
+ * *pm. You may need to manually free the created dictionary.
  *
  * @param key_val_sep  a 0-terminated list of characters used to separate
  *                     key from value