[FFmpeg-cvslog] lavu/opt: document av_opt_copy function

[Lukasz Marek]

ffmpeg | branch: master | Lukasz Marek <lukasz.m.luki2 at gmail.com> | Sat Nov  8 17:12:29 2014 +0100| [457204ee15923cb401368702567ce78bf9f612d8] | committer: Lukasz Marek

lavu/opt: document av_opt_copy function

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

 libavutil/opt.h |   10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/libavutil/opt.h b/libavutil/opt.h
index 1b72a10..df5a62e 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -815,6 +815,16 @@ void av_opt_freep_ranges(AVOptionRanges **ranges);
  */
 int av_opt_query_ranges(AVOptionRanges **, void *obj, const char *key, int flags);
 
+/**
+ * Copy options from src object into dest object.
+ *
+ * Options that require memory allocation (e.g. string or binary) are malloc'ed in dest object.
+ * Original memory allocated for such options is freed unless both src and dest options points to the same memory.
+ *
+ * @param dest Object to copy from
+ * @param src  Object to copy into
+ * @return 0 on success, negative on error
+ */
 int av_opt_copy(void *dest, void *src);
 
 /**