doxygen: Add a note on libavutil's modular nature

22df70e9 · Timothy Gu · 52ec4cc0 · 22df70e9
Commit 22df70e9 authored Jul 30, 2016 by Timothy Gu
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 6 deletions

avutil.h libavutil/avutil.h +10 -6

No files found.
--- 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
+ * libavutil contains the code shared across all the other FFmpeg libraries.
- * libraries
+ *
- *
+ * @note
- * @note In order to use the functions provided by avutil you must include
+ * libavutil is designed to be modular. In most cases, in order to use the
- * the specific header.
+ * 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.
 *
 * @{
 *