doxygen: Add a note on libavutil's modular nature
authorTimothy Gu <timothygu99@gmail.com>
Sat, 30 Jul 2016 00:18:09 +0000 (17:18 -0700)
committerTimothy Gu <timothygu99@gmail.com>
Sat, 30 Jul 2016 02:01:40 +0000 (19:01 -0700)
libavutil/avutil.h

index c1f76c1..27e9cf0 100644 (file)
@@ -23,7 +23,8 @@
 
 /**
  * @file
- * external API header
+ * @ingroup lavu
+ * Convenience header that includes @ref lavu "libavutil"'s core.
  */
 
 /**
  * @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.
  *
  * @{
  *