From: Pengfei Qu <Pengfei.Qu@intel.com>
Date: Thu, 21 Dec 2017 08:06:03 +0000 (+0800)
Subject: Update for  the documents generation
X-Git-Tag: android-x86-8.1-r1~65
X-Git-Url: http://git.osdn.net/view?p=android-x86%2Fhardware-intel-common-libva.git;a=commitdiff_plain;h=5660d45eb8b96057b88a8553066ebe8055844c06

Update for  the documents generation

Fixes#163

this  will update the documents.

Signed-off-by: Pengfei Qu <Pengfei.Qu@intel.com>
---

diff --git a/va/va.h b/va/va.h
index 62aaaa2..7d7a644 100644
--- a/va/va.h
+++ b/va/va.h
@@ -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
 {