API: h264 encode: fix comments.
authorGwenole Beauchesne <gwenole.beauchesne@intel.com>
Thu, 24 Nov 2011 12:15:52 +0000 (12:15 +0000)
committerXiang, Haihao <haihao.xiang@intel.com>
Tue, 28 May 2013 08:19:08 +0000 (16:19 +0800)
va/va.h
va/va_enc_h264.h

diff --git a/va/va.h b/va/va.h
index 1e5b470..482c14c 100644 (file)
--- a/va/va.h
+++ b/va/va.h
@@ -297,7 +297,7 @@ typedef enum
      */
     VAConfigAttribEncInterlaced         = 11,
     /**
-     * \brief Max number of reference frames. Read-only.
+     * \brief Maximum number of reference frames. Read-only.
      *
      * This attribute determines the maximum number of reference
      * frames supported for encoding.
@@ -358,7 +358,7 @@ typedef struct _VAConfigAttrib {
 #define VA_RC_VBR      0x00000004      
 #define VA_RC_VCM      0x00000008 /* video conference mode */
 
-/** @name Attribute values for VAConfigAttribuEncPackedHeaders */
+/** @name Attribute values for VAConfigAttribEncPackedHeaders */
 /**@{*/
 /** \brief Driver does not support any packed headers mode. */
 #define VA_ENC_PACKED_HEADER_NONE       0x00000000
@@ -370,7 +370,7 @@ typedef struct _VAConfigAttrib {
 #define VA_ENC_PACKED_HEADER_SLICE      0x00000004
 /**@}*/
 
-/** @name Attribute values for VAConfigAttributeEncInterlaced */
+/** @name Attribute values for VAConfigAttribEncInterlaced */
 /**@{*/
 /** \brief Driver does not support interlaced coding. */
 #define VA_ENC_INTERLACED_NONE          0x00000000
@@ -380,7 +380,7 @@ typedef struct _VAConfigAttrib {
 #define VA_ENC_INTERLACED_FIELD         0x00000002
 /** \brief Driver supports macroblock adaptive frame field coding. */
 #define VA_ENC_INTERLACED_MBAFF         0x00000004
-/** \brief Driver support picture adaptive frame field coding. */
+/** \brief Driver supports picture adaptive frame field coding. */
 #define VA_ENC_INTERLACED_PAFF          0x00000008
 /**@}*/
 
index cfaa4ed..a57c333 100644 (file)
@@ -79,7 +79,7 @@ extern "C" {
  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
  *   header data.
  *
- * If \ref seq_scaling_matrix_present_flag is set to \c 1, then a
+ * If \c seq_scaling_matrix_present_flag is set to \c 1, then a
  * #VAIQMatrixBufferH264 buffer shall also be provided within the same
  * \c vaRenderPicture() call as this sequence parameter buffer.
  */
@@ -207,7 +207,7 @@ typedef struct _VAEncSequenceParameterBufferH264 {
  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
  *   header data.
  *
- * If \ref pic_scaling_matrix_present_flag is set to \c 1, then a
+ * If \c pic_scaling_matrix_present_flag is set to \c 1, then a
  * #VAIQMatrixBufferH264 buffer shall also be provided within the same
  * \c vaRenderPicture() call as this picture parameter buffer.
  */
@@ -307,7 +307,7 @@ typedef struct _VAEncPictureParameterBufferH264 {
  * - a #VAEncPackedHeaderDataBuffer which holds the actual packed
  *   header data.
  *
- * If per-macroblock encoder configuration is needed, \ref macroblock_info
+ * If per-macroblock encoder configuration is needed, \c macroblock_info
  * references a buffer of type #VAEncMacroblockParameterBufferH264. This
  * buffer is not passed to vaRenderPicture(). i.e. it is not destroyed
  * by subsequent calls to vaRenderPicture() and then can be re-used