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

1 files changed, 4 insertions, 1 deletions

diff --git a/libavutil/dict.h b/libavutil/dict.h
index 5d66bb7e93..1dfc5a6443 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