diff options
author | Pengfei Qu <Pengfei.Qu@intel.com> | 2017-12-21 16:06:03 +0800 |
---|---|---|
committer | Xiang, Haihao <haihao.xiang@intel.com> | 2018-01-03 16:09:49 +0800 |
commit | 5660d45eb8b96057b88a8553066ebe8055844c06 (patch) | |
tree | b8699f18e40291162bfbefcd05031af896723cf8 | |
parent | 35d7d312d45f9fd42dd2566a45bc5e71313d16c8 (diff) | |
download | libva-5660d45eb8b96057b88a8553066ebe8055844c06.tar.gz |
Update for the documents generation
Fixes#163
this will update the documents.
Signed-off-by: Pengfei Qu <Pengfei.Qu@intel.com>
-rw-r--r-- | va/va.h | 19 | ||||
-rw-r--r-- | va/va_dec_vp9.h | 10 | ||||
-rw-r--r-- | va/va_fei.h | 6 | ||||
-rw-r--r-- | va/va_fei_h264.h | 6 | ||||
-rw-r--r-- | va/va_fei_hevc.h | 6 |
5 files changed, 34 insertions, 13 deletions
@@ -112,10 +112,23 @@ extern "C" { * * VA-API is split into several modules: * - \ref api_core - * - \ref api_enc_xxx (xxx = h264, hevc, jpec, mpeg2, vp8, vp9) - * - \ref api_dec_xxx (xxx = hevc, jpec, vp8, vp9) + * - Encoder (H264, HEVC, JPEG, MPEG2, VP8, VP9) + * - \ref api_enc_h264 + * - \ref api_enc_hevc + * - \ref api_enc_jpeg + * - \ref api_enc_mpeg2 + * - \ref api_enc_vp8 + * - \ref api_enc_vp9 + * - Decoder (HEVC, JPEG, VP8, VP9) + * - \ref api_dec_hevc + * - \ref api_dec_jpeg + * - \ref api_dec_vp8 + * - \ref api_dec_vp9 * - \ref api_vpp - * - \ref api_fei_xxx (xxx = h264, hevc) + * - FEI (H264, HEVC) + * - \ref api_fei + * - \ref api_fei_h264 + * - \ref api_fei_hevc */ /** diff --git a/va/va_dec_vp9.h b/va/va_dec_vp9.h index bbc39fd..490908f 100644 --- a/va/va_dec_vp9.h +++ b/va/va_dec_vp9.h @@ -57,8 +57,6 @@ extern "C" { */ typedef struct _VADecPictureParameterBufferVP9 { - /**@{*/ - /** \brief picture width * Picture original resolution. The value may not be multiple of 8. */ @@ -194,8 +192,6 @@ typedef struct _VADecPictureParameterBufferVP9 /** \brief Reserved bytes for future use, must be zero */ uint32_t va_reserved[VA_PADDING_MEDIUM]; - /**@}*/ - } VADecPictureParameterBufferVP9; @@ -210,8 +206,6 @@ typedef struct _VADecPictureParameterBufferVP9 */ typedef struct _VASegmentParameterVP9 { - /**@{*/ - union { struct @@ -269,8 +263,6 @@ typedef struct _VASegmentParameterVP9 /** \brief Reserved bytes for future use, must be zero */ uint32_t va_reserved[VA_PADDING_LOW]; - /**@}*/ - } VASegmentParameterVP9; @@ -292,7 +284,6 @@ typedef struct _VASegmentParameterVP9 */ typedef struct _VASliceParameterBufferVP9 { - /**@{*/ /** \brief The byte count of current frame in the bitstream buffer, * starting from first byte of the buffer. * It uses the name slice_data_size to be consitent with other codec, @@ -315,7 +306,6 @@ typedef struct _VASliceParameterBufferVP9 /** \brief Reserved bytes for future use, must be zero */ uint32_t va_reserved[VA_PADDING_LOW]; - /**@}*/ } VASliceParameterBufferVP9; diff --git a/va/va_fei.h b/va/va_fei.h index 5968ba6..921e896 100644 --- a/va/va_fei.h +++ b/va/va_fei.h @@ -37,6 +37,12 @@ extern "C" { #include <stdint.h> /** + * \defgroup api_fei FEI encoding common API + * + * @{ + */ + +/** * \brief FEI specific attribute definitions */ /** @name Attribute values for VAConfigAttribFEIFunctionType diff --git a/va/va_fei_h264.h b/va/va_fei_h264.h index be524af..08c29c9 100644 --- a/va/va_fei_h264.h +++ b/va/va_fei_h264.h @@ -37,6 +37,12 @@ extern "C" { #include <stdint.h> #include "va_fei.h" +/** + * \defgroup api_fei_h264 H.264 FEI encoding API + * + * @{ + */ + /** \brief FEI frame level control buffer for H.264 */ typedef struct _VAEncMiscParameterFEIFrameControlH264 { diff --git a/va/va_fei_hevc.h b/va/va_fei_hevc.h index 51bd055..e7c19ea 100644 --- a/va/va_fei_hevc.h +++ b/va/va_fei_hevc.h @@ -38,6 +38,12 @@ extern "C" { #include <stdint.h> #include "va_fei.h" +/** + * \defgroup api_fei_hevc HEVC FEI encoding API + * + * @{ + */ + /** \brief FEI frame level control buffer for HEVC */ typedef struct _VAEncMiscParameterFEIFrameControlHEVC { |