Browse Source

doxygen: Standardize root-level modules

tags/n3.2
Timothy Gu 9 years ago
parent
commit
58c7bf789f
11 changed files with 39 additions and 26 deletions
  1. +3
    -1
      libavcodec/avcodec.h
  2. +9
    -3
      libavdevice/avdevice.h
  3. +3
    -1
      libavfilter/avfilter.h
  4. +4
    -2
      libavformat/avformat.h
  5. +1
    -1
      libavresample/avresample.h
  6. +2
    -4
      libavutil/avutil.h
  7. +1
    -0
      libavutil/frame.h
  8. +8
    -9
      libavutil/version.h
  9. +3
    -1
      libpostproc/postprocess.h
  10. +2
    -3
      libswresample/swresample.h
  11. +3
    -1
      libswscale/swscale.h

+ 3
- 1
libavcodec/avcodec.h View File

@@ -43,7 +43,9 @@
#include "version.h"

/**
* @defgroup libavc Encoding/Decoding Library
* @defgroup libavc libavcodec
* Encoding/Decoding Library
*
* @{
*
* @defgroup lavc_decoding Decoding


+ 9
- 3
libavdevice/avdevice.h View File

@@ -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 */

+ 3
- 1
libavfilter/avfilter.h View File

@@ -29,7 +29,9 @@
*/

/**
* @defgroup lavfi Libavfilter - graph-based frame editing library
* @defgroup lavfi libavfilter
* Graph-based frame editing library.
*
* @{
*/



+ 4
- 2
libavformat/avformat.h View File

@@ -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


+ 1
- 1
libavresample/avresample.h View File

@@ -28,7 +28,7 @@
*/

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


+ 2
- 4
libavutil/avutil.h View File

@@ -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


+ 1
- 0
libavutil/frame.h View File

@@ -385,6 +385,7 @@ typedef struct AVFrame {

/**
* @defgroup lavu_frame_flags AV_FRAME_FLAGS
* @ingroup lavu_frame
* Flags describing additional frame properties.
*
* @{


+ 8
- 9
libavutil/version.h View File

@@ -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

@@ -48,12 +54,6 @@
* @}
*/

/**
* @file
* @ingroup lavu
* Libavutil version macros
*/

/**
* @defgroup lavu_ver Version and Build diagnostics
*
@@ -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.
@@ -122,6 +120,7 @@


/**
* @}
* @}
*/



+ 3
- 1
libpostproc/postprocess.h View File

@@ -28,7 +28,9 @@
*/

/**
* @defgroup lpp Libpostproc
* @defgroup lpp libpostproc
* Video postprocessing library.
*
* @{
*/



+ 2
- 3
libswresample/swresample.h View File

@@ -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


+ 3
- 1
libswscale/swscale.h View File

@@ -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.


Loading…
Cancel
Save