har0ke/FFmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doxygen: Add a note on libavutil's modular nature

Browse Source
This commit is contained in:
Timothy Gu 2016-07-29 17:18:09 -07:00
parent 52ec4cc09b
commit 22df70e9ed
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
libavutil/avutil.h
View File

@ -23,7 +23,8 @@
/** /**
* @file * @file
* external API header * @ingroup lavu
* Convenience header that includes @ref lavu "libavutil"'s core.
*/ */
/** /**
@ -81,11 +82,14 @@
* @defgroup lavu Common utility functions * @defgroup lavu Common utility functions
* *
* @brief * @brief
* libavutil contains the code shared across all the other FFmpeg * libavutil contains the code shared across all the other FFmpeg libraries.
* libraries
* *
* @note In order to use the functions provided by avutil you must include * @note
* the specific header. * 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.
* *
* @{ * @{
* *