AVOptions: move doxy for av_opt_set_defaults() from opt.c to opt.h
authorAnton Khirnov <anton@khirnov.net>
Sun, 4 Sep 2011 09:39:49 +0000 (11:39 +0200)
committerAnton Khirnov <anton@khirnov.net>
Wed, 7 Sep 2011 09:16:52 +0000 (11:16 +0200)
Also change it to be more readable.

libavutil/opt.c
libavutil/opt.h

index 707977a7a9e8e469a3e3a526cf5d2dbca89e47cf..0dd58a7f14397b7c3d769121a865c4a1ad19f8b2 100644 (file)
@@ -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;
index 68d2c798e25df9d310b22fdd01e1e585c10180b8..f8eea6bc2a8c52e9f5af10f8dbdbbbad8eff2b5c 100644 (file)
@@ -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);