doxygen: Standardize root-level modules

pull/228/head
Timothy Gu 8 years ago
parent a4d7a6d1dd
commit 58c7bf789f
  1. 4
      libavcodec/avcodec.h
  2. 12
      libavdevice/avdevice.h
  3. 4
      libavfilter/avfilter.h
  4. 6
      libavformat/avformat.h
  5. 2
      libavresample/avresample.h
  6. 6
      libavutil/avutil.h
  7. 1
      libavutil/frame.h
  8. 17
      libavutil/version.h
  9. 4
      libpostproc/postprocess.h
  10. 5
      libswresample/swresample.h
  11. 4
      libswscale/swscale.h

@ -43,7 +43,9 @@
#include "version.h" #include "version.h"
/** /**
* @defgroup libavc Encoding/Decoding Library * @defgroup libavc libavcodec
* Encoding/Decoding Library
*
* @{ * @{
* *
* @defgroup lavc_decoding Decoding * @defgroup lavc_decoding Decoding

@ -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 * Libavdevice is a complementary library to @ref libavf "libavformat". It
* provides various "special" platform-specific muxers and demuxers, e.g. for * provides various "special" platform-specific muxers and demuxers, e.g. for
* grabbing devices, audio capture and playback etc. As a consequence, the * 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 * To use libavdevice, simply call avdevice_register_all() to register all
* compiled muxers and demuxers. They all use standard libavformat API. * compiled muxers and demuxers. They all use standard libavformat API.
* @} *
* @{
*/ */
#include "libavutil/log.h" #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, int avdevice_list_output_sinks(struct AVOutputFormat *device, const char *device_name,
AVDictionary *device_options, AVDeviceInfoList **device_list); AVDictionary *device_options, AVDeviceInfoList **device_list);
/**
* @}
*/
#endif /* AVDEVICE_AVDEVICE_H */ #endif /* AVDEVICE_AVDEVICE_H */

@ -29,7 +29,9 @@
*/ */
/** /**
* @defgroup lavfi Libavfilter - graph-based frame editing library * @defgroup lavfi libavfilter
* Graph-based frame editing library.
*
* @{ * @{
*/ */

@ -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 * Libavformat (lavf) is a library for dealing with various media container
* formats. Its main two purposes are demuxing - i.e. splitting a media file * 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 * both local and remote files, parts of them, concatenations of them, local
* audio and video devices and so on. * audio and video devices and so on.
* *
* @{
*
* @defgroup lavf_decoding Demuxing * @defgroup lavf_decoding Demuxing
* @{ * @{
* Demuxers read a media file and split it into chunks of data (@em packets). A * Demuxers read a media file and split it into chunks of data (@em packets). A

@ -28,7 +28,7 @@
*/ */
/** /**
* @defgroup lavr Libavresample * @defgroup lavr libavresample
* @{ * @{
* *
* Libavresample (lavr) is a library that handles audio resampling, sample * Libavresample (lavr) is a library that handles audio resampling, sample

@ -79,10 +79,8 @@
*/ */
/** /**
* @defgroup lavu Common utility functions * @defgroup lavu libavutil
* * Common code shared across all FFmpeg libraries.
* @brief
* libavutil contains the code shared across all the other FFmpeg libraries.
* *
* @note * @note
* libavutil is designed to be modular. In most cases, in order to use the * libavutil is designed to be modular. In most cases, in order to use the

@ -385,6 +385,7 @@ typedef struct AVFrame {
/** /**
* @defgroup lavu_frame_flags AV_FRAME_FLAGS * @defgroup lavu_frame_flags AV_FRAME_FLAGS
* @ingroup lavu_frame
* Flags describing additional frame properties. * Flags describing additional frame properties.
* *
* @{ * @{

@ -18,6 +18,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/ */
/**
* @file
* @ingroup lavu
* Libavutil version macros
*/
#ifndef AVUTIL_VERSION_H #ifndef AVUTIL_VERSION_H
#define AVUTIL_VERSION_H #define AVUTIL_VERSION_H
@ -48,12 +54,6 @@
* @} * @}
*/ */
/**
* @file
* @ingroup lavu
* Libavutil version macros
*/
/** /**
* @defgroup lavu_ver Version and Build diagnostics * @defgroup lavu_ver Version and Build diagnostics
* *
@ -78,9 +78,7 @@
#define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION) #define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION)
/** /**
* @} * @defgroup lavu_depr_guards Deprecation Guards
*
* @defgroup depr_guards Deprecation guards
* FF_API_* defines may be placed below to indicate public API that will be * 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 * 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. * the public API and may change, break or disappear at any time.
@ -122,6 +120,7 @@
/** /**
* @}
* @} * @}
*/ */

@ -28,7 +28,9 @@
*/ */
/** /**
* @defgroup lpp Libpostproc * @defgroup lpp libpostproc
* Video postprocessing library.
*
* @{ * @{
*/ */

@ -28,11 +28,10 @@
*/ */
/** /**
* @defgroup lswr Libswresample * @defgroup lswr libswresample
* @{ * @{
* *
* Libswresample (lswr) is a library that handles audio resampling, sample * Audio resampling, sample format conversion and mixing library.
* format conversion and mixing.
* *
* Interaction with lswr is done through SwrContext, which is * Interaction with lswr is done through SwrContext, which is
* allocated with swr_alloc() or swr_alloc_set_opts(). It is opaque, so all parameters * allocated with swr_alloc() or swr_alloc_set_opts(). It is opaque, so all parameters

@ -35,7 +35,9 @@
#include "version.h" #include "version.h"
/** /**
* @defgroup libsws Color conversion and scaling * @defgroup libsws libswscale
* Color conversion and scaling library.
*
* @{ * @{
* *
* Return the LIBSWSCALE_VERSION_INT constant. * Return the LIBSWSCALE_VERSION_INT constant.

Loading…
Cancel
Save