[FFmpeg-cvslog] doxygen: Add a note on libavutil's modular nature
Timothy Gu
git at videolan.org
Sat Jul 30 05:01:47 EEST 2016
ffmpeg | branch: master | Timothy Gu <timothygu99 at gmail.com> | Fri Jul 29 17:18:09 2016 -0700| [22df70e9edaa8353e5edcc65c660d2d9f19ede5a] | committer: Timothy Gu
doxygen: Add a note on libavutil's modular nature
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=22df70e9edaa8353e5edcc65c660d2d9f19ede5a
---
libavutil/avutil.h | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/libavutil/avutil.h b/libavutil/avutil.h
index c1f76c1..27e9cf0 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.
*
* @{
*
More information about the ffmpeg-cvslog
mailing list