diff options
| author | Timothy Gu <timothygu99@gmail.com> | 2016-07-29 17:18:09 -0700 |
|---|---|---|
| committer | Timothy Gu <timothygu99@gmail.com> | 2016-07-29 19:01:40 -0700 |
| commit | 22df70e9edaa8353e5edcc65c660d2d9f19ede5a (patch) | |
| tree | 28384b79eb7218163877c997ff6ecaf9e9506b05 /libavutil/avutil.h | |
| parent | 52ec4cc09b5be755f166b7ed4755433c95173d6d (diff) | |
doxygen: Add a note on libavutil's modular nature
Diffstat (limited to 'libavutil/avutil.h')
| -rw-r--r-- | libavutil/avutil.h | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/libavutil/avutil.h b/libavutil/avutil.h index c1f76c16ea..27e9cf0f67 100644 --- a/libavutil/avutil.h +++ b/libavutil/avutil.h @@ -23,7 +23,8 @@ /** * @file - * external API header + * @ingroup lavu + * Convenience header that includes @ref lavu "libavutil"'s core. */ /** @@ -81,11 +82,14 @@ * @defgroup lavu Common utility functions * * @brief - * libavutil contains the code shared across all the other FFmpeg - * libraries - * - * @note In order to use the functions provided by avutil you must include - * the specific header. + * libavutil contains the code shared across all the other FFmpeg libraries. + * + * @note + * libavutil is designed to be modular. In most cases, in order to use the + * functions provided by one component of libavutil you must explicitly include + * the specific header containing that feature. If you are only using + * media-related components, you could simply include libavutil/avutil.h, which + * brings in most of the "core" components. * * @{ * |