docs: fix references and descriptions

Signed-off-by: Dmitry Rogozhkin <dmitry.v.rogozhkin@intel.com>
intel · Jun 1, 2023 · f4c4c03 · f4c4c03
1 parent e42500d
commit f4c4c03
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/va/va.h b/va/va.h
@@ -401,6 +401,7 @@ typedef int VAStatus;   /** Return status type from functions */
  */
 const char *vaErrorStr(VAStatus error_status);
 
+/** \brief Structure to describe rectangle. */
 typedef struct _VARectangle {
     int16_t x;
     int16_t y;
@@ -410,12 +411,18 @@ typedef struct _VARectangle {
 
 /** \brief Generic motion vector data structure. */
 typedef struct _VAMotionVector {
-    /** \mv0[0]: horizontal motion vector for past reference */
-    /** \mv0[1]: vertical motion vector for past reference */
-    /** \mv1[0]: horizontal motion vector for future reference */
-    /** \mv1[1]: vertical motion vector for future reference */
-    int16_t  mv0[2];  /* past reference */
-    int16_t  mv1[2];  /* future reference */
+    /** \brief Past reference
+     *
+     * - \c [0]: horizontal motion vector for past reference
+     * - \c [1]: vertical motion vector for past reference
+     */
+    int16_t  mv0[2];
+    /** \brief Future reference
+     *
+     * - \c [0]: horizontal motion vector for future reference
+     * - \c [1]: vertical motion vector for future reference
+     */
+    int16_t  mv1[2];
 } VAMotionVector;
 
 /** Type of a message callback, used for both error and info log. */
@@ -1771,7 +1778,7 @@ typedef struct _VASurfaceAttribExternalBuffers {
  * \brief Queries surface attributes for the supplied config.
  *
  * This function queries for all supported attributes for the
- * supplied VA @config. In particular, if the underlying hardware
+ * supplied VA \c config. In particular, if the underlying hardware
  * supports the creation of VA surfaces in various formats, then
  * this function will enumerate all pixel formats that are supported.
  *

diff --git a/va/va_vpp.h b/va/va_vpp.h
@@ -480,22 +480,22 @@ typedef struct _VABlendState {
     /**
      * \brief Global alpha value.
      *
-     * Valid if \flags has VA_BLEND_GLOBAL_ALPHA.
+     * Valid if \ref flags has VA_BLEND_GLOBAL_ALPHA.
      * Valid range is 0.0 to 1.0 inclusive.
      */
     float               global_alpha;
     /**
      * \brief Minimum luma value.
      *
-     * Valid if \flags has VA_BLEND_LUMA_KEY.
+     * Valid if \ref flags has VA_BLEND_LUMA_KEY.
      * Valid range is 0.0 to 1.0 inclusive.
      * \ref min_luma shall be set to a sensible value lower than \ref max_luma.
      */
     float               min_luma;
     /**
      * \brief Maximum luma value.
      *
-     * Valid if \flags has VA_BLEND_LUMA_KEY.
+     * Valid if \ref flags has VA_BLEND_LUMA_KEY.
      * Valid range is 0.0 to 1.0 inclusive.
      * \ref max_luma shall be set to a sensible value larger than \ref min_luma.
      */