lavu/opt: Clarify the scope of AVOptions

See discussion on the mailing list:
https://ffmpeg.org/pipermail/ffmpeg-devel/2024-April/326054.html

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
This commit is contained in:
Andrew Sayers 2024-04-24 08:30:28 +01:00 committed by Michael Niedermayer
parent 9f54c13bc4
commit 99e43a6dfe
No known key found for this signature in database
GPG Key ID: B18E8928B3948D64
1 changed files with 10 additions and 0 deletions

View File

@ -53,6 +53,16 @@
* question is allowed to access the field. This allows us to extend the
* semantics of those fields without breaking API compatibility.
*
* @section avoptions_scope Scope of AVOptions
*
* AVOptions is designed to support any set of multimedia configuration options
* that can be defined at compile-time. Although it is mainly used to expose
* FFmpeg options, you are welcome to adapt it to your own use case.
*
* No single approach can ever fully solve the problem of configuration,
* but please submit a patch if you believe you have found a problem
* that is best solved by extending AVOptions.
*
* @section avoptions_implement Implementing AVOptions
* This section describes how to add AVOptions capabilities to a struct.
*