[FFmpeg-cvslog] lavc doxy: add all installed headers to doxy groups.
Anton Khirnov
git at videolan.org
Tue Apr 10 23:07:20 CEST 2012
ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Sun Apr 8 14:08:05 2012 +0200| [7c59b5c2a5a19638c6c4411fb96fcd50066905c6] | committer: Anton Khirnov
lavc doxy: add all installed headers to doxy groups.
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=7c59b5c2a5a19638c6c4411fb96fcd50066905c6
---
libavcodec/dxva2.h | 17 +++++++++++++++++
libavcodec/vaapi.h | 10 ++++++++--
libavcodec/vda.h | 17 +++++++++++++++++
libavcodec/vdpau.h | 12 +++++++++---
libavcodec/version.h | 6 ++++++
libavcodec/xvmc.h | 17 +++++++++++++++++
6 files changed, 74 insertions(+), 5 deletions(-)
diff --git a/libavcodec/dxva2.h b/libavcodec/dxva2.h
index 374ae03..c06f1f3 100644
--- a/libavcodec/dxva2.h
+++ b/libavcodec/dxva2.h
@@ -23,11 +23,24 @@
#ifndef AVCODEC_DXVA_H
#define AVCODEC_DXVA_H
+/**
+ * @file
+ * @ingroup lavc_codec_hwaccel_dxva2
+ * Public libavcodec DXVA2 header.
+ */
+
#include <stdint.h>
#include <d3d9.h>
#include <dxva2api.h>
+/**
+ * @defgroup lavc_codec_hwaccel_dxva2 DXVA2
+ * @ingroup lavc_codec_hwaccel
+ *
+ * @{
+ */
+
#define FF_DXVA2_WORKAROUND_SCALING_LIST_ZIGZAG 1 ///< Work around for DXVA2 and old UVD/UVD+ ATI video cards
/**
@@ -68,4 +81,8 @@ struct dxva_context {
unsigned report_id;
};
+/**
+ * @}
+ */
+
#endif /* AVCODEC_DXVA_H */
diff --git a/libavcodec/vaapi.h b/libavcodec/vaapi.h
index 36fb386..39e8825 100644
--- a/libavcodec/vaapi.h
+++ b/libavcodec/vaapi.h
@@ -24,11 +24,17 @@
#ifndef AVCODEC_VAAPI_H
#define AVCODEC_VAAPI_H
+/**
+ * @file
+ * @ingroup lavc_codec_hwaccel_vaapi
+ * Public libavcodec VA API header.
+ */
+
#include <stdint.h>
/**
- * @defgroup VAAPI_Decoding VA API Decoding
- * @ingroup Decoder
+ * @defgroup lavc_codec_hwaccel_vaapi VA API Decoding
+ * @ingroup lavc_codec_hwaccel
* @{
*/
diff --git a/libavcodec/vda.h b/libavcodec/vda.h
index 2cb51c5..79fbfe8 100644
--- a/libavcodec/vda.h
+++ b/libavcodec/vda.h
@@ -23,6 +23,12 @@
#ifndef AVCODEC_VDA_H
#define AVCODEC_VDA_H
+/**
+ * @file
+ * @ingroup lavc_codec_hwaccel_vda
+ * Public libavcodec VDA header.
+ */
+
#include <pthread.h>
#include <stdint.h>
@@ -35,6 +41,13 @@
#undef Picture
/**
+ * @defgroup lavc_codec_hwaccel_vda VDA
+ * @ingroup lavc_codec_hwaccel
+ *
+ * @{
+ */
+
+/**
* This structure is used to store a decoded frame information and data.
*/
typedef struct vda_frame {
@@ -141,4 +154,8 @@ vda_frame *ff_vda_queue_pop(struct vda_context *vda_ctx);
/** Release the given frame. */
void ff_vda_release_vda_frame(vda_frame *frame);
+/**
+ * @}
+ */
+
#endif /* AVCODEC_VDA_H */
diff --git a/libavcodec/vdpau.h b/libavcodec/vdpau.h
index 6f13860..241ff19 100644
--- a/libavcodec/vdpau.h
+++ b/libavcodec/vdpau.h
@@ -25,7 +25,15 @@
#define AVCODEC_VDPAU_H
/**
- * @defgroup Decoder VDPAU Decoder and Renderer
+ * @file
+ * @ingroup lavc_codec_hwaccel_vdpau
+ * Public libavcodec VDPAU header.
+ */
+
+
+/**
+ * @defgroup lavc_codec_hwaccel_vdpau VDPAU Decoder and Renderer
+ * @ingroup lavc_codec_hwaccel
*
* VDPAU hardware acceleration has two modules
* - VDPAU decoding
@@ -38,8 +46,6 @@
* and rendering (API calls) are done as part of the VDPAU
* presentation (vo_vdpau.c) module.
*
- * @defgroup VDPAU_Decoding VDPAU Decoding
- * @ingroup Decoder
* @{
*/
diff --git a/libavcodec/version.h b/libavcodec/version.h
index 5719e7f..c35fce4 100644
--- a/libavcodec/version.h
+++ b/libavcodec/version.h
@@ -20,6 +20,12 @@
#ifndef AVCODEC_VERSION_H
#define AVCODEC_VERSION_H
+/**
+ * @file
+ * @ingroup libavc
+ * Libavcodec version macros.
+ */
+
#define LIBAVCODEC_VERSION_MAJOR 54
#define LIBAVCODEC_VERSION_MINOR 11
#define LIBAVCODEC_VERSION_MICRO 1
diff --git a/libavcodec/xvmc.h b/libavcodec/xvmc.h
index 1239015..cdec161 100644
--- a/libavcodec/xvmc.h
+++ b/libavcodec/xvmc.h
@@ -21,10 +21,23 @@
#ifndef AVCODEC_XVMC_H
#define AVCODEC_XVMC_H
+/**
+ * @file
+ * @ingroup lavc_codec_hwaccel_xvmc
+ * Public libavcodec XvMC header.
+ */
+
#include <X11/extensions/XvMC.h>
#include "avcodec.h"
+/**
+ * @defgroup lavc_codec_hwaccel_xvmc XvMC
+ * @ingroup lavc_codec_hwaccel
+ *
+ * @{
+ */
+
#define AV_XVMC_ID 0x1DC711C0 /**< special value to ensure that regular pixel routines haven't corrupted the struct
the number is 1337 speak for the letters IDCT MCo (motion compensation) */
@@ -148,4 +161,8 @@ struct xvmc_pix_fmt {
int next_free_data_block_num;
};
+/**
+ * @}
+ */
+
#endif /* AVCODEC_XVMC_H */
More information about the ffmpeg-cvslog
mailing list