[FFmpeg-cvslog] AVOptions: move doxy for av_opt_set_defaults() from opt.c to opt.h

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Sun Sep  4 11:39:49 2011 +0200| [a7e2b2ccc9e184820f13894de6cb7e49abcb6130] | committer: Anton Khirnov

AVOptions: move doxy for av_opt_set_defaults() from opt.c to opt.h

Also change it to be more readable.

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

 libavutil/opt.c |    6 ------
 libavutil/opt.h |    5 +++++
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/libavutil/opt.c b/libavutil/opt.c
index 707977a..0dd58a7 100644
--- a/libavutil/opt.c
+++ b/libavutil/opt.c
@@ -414,12 +414,6 @@ int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags)
     return 0;
 }
 
-/** Set the values of the AVCodecContext or AVFormatContext structure.
- * They are set to the defaults specified in the according AVOption options
- * array default_val field.
- *
- * @param s AVCodecContext or AVFormatContext for which the defaults will be set
- */
 void av_opt_set_defaults2(void *s, int mask, int flags)
 {
     const AVOption *opt = NULL;
diff --git a/libavutil/opt.h b/libavutil/opt.h
index 68d2c79..f8eea6b 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -160,6 +160,11 @@ const AVOption *av_next_option(void *obj, const AVOption *last);
  */
 int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags);
 
+/**
+ * Set the values of all AVOption fields to their default values.
+ *
+ * @param s an AVOption-enabled struct (its first member must be a pointer to AVClass)
+ */
 void av_opt_set_defaults(void *s);
 void av_opt_set_defaults2(void *s, int mask, int flags);