[FFmpeg-cvslog] doxygen: Standardize root-level modules
Timothy Gu
git at videolan.org
Wed Aug 3 08:15:34 EEST 2016
ffmpeg | branch: master | Timothy Gu <timothygu99 at gmail.com> | Tue Aug 2 22:05:27 2016 -0700| [58c7bf789f0b5c7345efdfe8313012835337efd6] | committer: Timothy Gu
doxygen: Standardize root-level modules
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=58c7bf789f0b5c7345efdfe8313012835337efd6
---
libavcodec/avcodec.h | 4 +++-
libavdevice/avdevice.h | 12 +++++++++---
libavfilter/avfilter.h | 4 +++-
libavformat/avformat.h | 6 ++++--
libavresample/avresample.h | 2 +-
libavutil/avutil.h | 6 ++----
libavutil/frame.h | 1 +
libavutil/version.h | 17 ++++++++---------
libpostproc/postprocess.h | 4 +++-
libswresample/swresample.h | 5 ++---
libswscale/swscale.h | 4 +++-
11 files changed, 39 insertions(+), 26 deletions(-)
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index ca8dba8..3b21537 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -43,7 +43,9 @@
#include "version.h"
/**
- * @defgroup libavc Encoding/Decoding Library
+ * @defgroup libavc libavcodec
+ * Encoding/Decoding Library
+ *
* @{
*
* @defgroup lavc_decoding Decoding
diff --git a/libavdevice/avdevice.h b/libavdevice/avdevice.h
index 6b0446c..6153f2c 100644
--- a/libavdevice/avdevice.h
+++ b/libavdevice/avdevice.h
@@ -28,8 +28,9 @@
*/
/**
- * @defgroup lavd Special devices muxing/demuxing library
- * @{
+ * @defgroup lavd libavdevice
+ * Special devices muxing/demuxing library.
+ *
* Libavdevice is a complementary library to @ref libavf "libavformat". It
* provides various "special" platform-specific muxers and demuxers, e.g. for
* grabbing devices, audio capture and playback etc. As a consequence, the
@@ -40,7 +41,8 @@
*
* To use libavdevice, simply call avdevice_register_all() to register all
* compiled muxers and demuxers. They all use standard libavformat API.
- * @}
+ *
+ * @{
*/
#include "libavutil/log.h"
@@ -506,4 +508,8 @@ int avdevice_list_input_sources(struct AVInputFormat *device, const char *device
int avdevice_list_output_sinks(struct AVOutputFormat *device, const char *device_name,
AVDictionary *device_options, AVDeviceInfoList **device_list);
+/**
+ * @}
+ */
+
#endif /* AVDEVICE_AVDEVICE_H */
diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index 757b81a..d804c89 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -29,7 +29,9 @@
*/
/**
- * @defgroup lavfi Libavfilter - graph-based frame editing library
+ * @defgroup lavfi libavfilter
+ * Graph-based frame editing library.
+ *
* @{
*/
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 818184e..b9fbb06 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -28,8 +28,8 @@
*/
/**
- * @defgroup libavf I/O and Muxing/Demuxing Library
- * @{
+ * @defgroup libavf libavformat
+ * I/O and Muxing/Demuxing Library
*
* Libavformat (lavf) is a library for dealing with various media container
* formats. Its main two purposes are demuxing - i.e. splitting a media file
@@ -90,6 +90,8 @@
* both local and remote files, parts of them, concatenations of them, local
* audio and video devices and so on.
*
+ * @{
+ *
* @defgroup lavf_decoding Demuxing
* @{
* Demuxers read a media file and split it into chunks of data (@em packets). A
diff --git a/libavresample/avresample.h b/libavresample/avresample.h
index 1c2bce8..4cfbdfc 100644
--- a/libavresample/avresample.h
+++ b/libavresample/avresample.h
@@ -28,7 +28,7 @@
*/
/**
- * @defgroup lavr Libavresample
+ * @defgroup lavr libavresample
* @{
*
* Libavresample (lavr) is a library that handles audio resampling, sample
diff --git a/libavutil/avutil.h b/libavutil/avutil.h
index ed1fbfd..29dd830 100644
--- a/libavutil/avutil.h
+++ b/libavutil/avutil.h
@@ -79,10 +79,8 @@
*/
/**
- * @defgroup lavu Common utility functions
- *
- * @brief
- * libavutil contains the code shared across all the other FFmpeg libraries.
+ * @defgroup lavu libavutil
+ * Common code shared across all FFmpeg libraries.
*
* @note
* libavutil is designed to be modular. In most cases, in order to use the
diff --git a/libavutil/frame.h b/libavutil/frame.h
index 2b5c332..8a41a86 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -385,6 +385,7 @@ typedef struct AVFrame {
/**
* @defgroup lavu_frame_flags AV_FRAME_FLAGS
+ * @ingroup lavu_frame
* Flags describing additional frame properties.
*
* @{
diff --git a/libavutil/version.h b/libavutil/version.h
index 07618fc..b2dffb7 100644
--- a/libavutil/version.h
+++ b/libavutil/version.h
@@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * @ingroup lavu
+ * Libavutil version macros
+ */
+
#ifndef AVUTIL_VERSION_H
#define AVUTIL_VERSION_H
@@ -49,12 +55,6 @@
*/
/**
- * @file
- * @ingroup lavu
- * Libavutil version macros
- */
-
-/**
* @defgroup lavu_ver Version and Build diagnostics
*
* Macros and function useful to check at compiletime and at runtime
@@ -78,9 +78,7 @@
#define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
/**
- * @}
- *
- * @defgroup depr_guards Deprecation guards
+ * @defgroup lavu_depr_guards Deprecation Guards
* FF_API_* defines may be placed below to indicate public API that will be
* dropped at a future version bump. The defines themselves are not part of
* the public API and may change, break or disappear at any time.
@@ -123,6 +121,7 @@
/**
* @}
+ * @}
*/
#endif /* AVUTIL_VERSION_H */
diff --git a/libpostproc/postprocess.h b/libpostproc/postprocess.h
index 2b55ed6..d180686 100644
--- a/libpostproc/postprocess.h
+++ b/libpostproc/postprocess.h
@@ -28,7 +28,9 @@
*/
/**
- * @defgroup lpp Libpostproc
+ * @defgroup lpp libpostproc
+ * Video postprocessing library.
+ *
* @{
*/
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index 10eaebc..a09563b 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -28,11 +28,10 @@
*/
/**
- * @defgroup lswr Libswresample
+ * @defgroup lswr libswresample
* @{
*
- * Libswresample (lswr) is a library that handles audio resampling, sample
- * format conversion and mixing.
+ * Audio resampling, sample format conversion and mixing library.
*
* Interaction with lswr is done through SwrContext, which is
* allocated with swr_alloc() or swr_alloc_set_opts(). It is opaque, so all parameters
diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index efcbef3..7713f51 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -35,7 +35,9 @@
#include "version.h"
/**
- * @defgroup libsws Color conversion and scaling
+ * @defgroup libsws libswscale
+ * Color conversion and scaling library.
+ *
* @{
*
* Return the LIBSWSCALE_VERSION_INT constant.
More information about the ffmpeg-cvslog
mailing list