Commit abe63303 authored by Michael Niedermayer's avatar Michael Niedermayer

AVoption doxy: clarify a few needs in relation to AVClass less structs.

Signed-off-by: 's avatarMichael Niedermayer <michaelni@gmx.at>
parent fc882b6e
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* This section describes how to add AVOptions capabilities to a struct. * This section describes how to add AVOptions capabilities to a struct.
* *
* All AVOptions-related information is stored in an AVClass. Therefore * All AVOptions-related information is stored in an AVClass. Therefore
* the first member of the struct must be a pointer to an AVClass describing it. * the first member of the struct should be a pointer to an AVClass describing it.
* The option field of the AVClass must be set to a NULL-terminated static array * The option field of the AVClass must be set to a NULL-terminated static array
* of AVOptions. Each AVOption must have a non-empty name, a type, a default * of AVOptions. Each AVOption must have a non-empty name, a type, a default
* value and for number-type AVOptions also a range of allowed values. It must * value and for number-type AVOptions also a range of allowed values. It must
...@@ -81,7 +81,7 @@ ...@@ -81,7 +81,7 @@
* @endcode * @endcode
* *
* Next, when allocating your struct, you must ensure that the AVClass pointer * Next, when allocating your struct, you must ensure that the AVClass pointer
* is set to the correct value. Then, av_opt_set_defaults() must be called to * is set to the correct value. Then, av_opt_set_defaults() can be called to
* initialize defaults. After that the struct is ready to be used with the * initialize defaults. After that the struct is ready to be used with the
* AVOptions API. * AVOptions API.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment