Doxygen comments for CDEF Info structure
Change-Id: I4bd5580ac55bf49aeb81c8ebfdf29a355a7a3eb8
diff --git a/av1/common/av1_common_int.h b/av1/common/av1_common_int.h
index 63cc8c7..eb5cd75 100644
--- a/av1/common/av1_common_int.h
+++ b/av1/common/av1_common_int.h
@@ -188,14 +188,20 @@
InternalFrameBufferList int_frame_buffers;
} BufferPool;
+/*!\endcond */
+
+/*!\brief Parameters related to CDEF */
typedef struct {
- int cdef_damping;
- int nb_cdef_strengths;
- int cdef_strengths[CDEF_MAX_STRENGTHS];
- int cdef_uv_strengths[CDEF_MAX_STRENGTHS];
- int cdef_bits;
+ int cdef_damping; /*!< CDEF damping factor */
+ int nb_cdef_strengths; /*!< Number of CDEF strength values */
+ int cdef_strengths[CDEF_MAX_STRENGTHS]; /*!< CDEF strength values for luma */
+ int cdef_uv_strengths[CDEF_MAX_STRENGTHS]; /*!< CDEF strength values for
+ chroma */
+ int cdef_bits; /*!< Number of CDEF strength values in bits */
} CdefInfo;
+/*!\cond */
+
typedef struct {
int delta_q_present_flag;
// Resolution of delta quant
diff --git a/av1/encoder/pickcdef.h b/av1/encoder/pickcdef.h
index eaa3e95..fc81617 100644
--- a/av1/encoder/pickcdef.h
+++ b/av1/encoder/pickcdef.h
@@ -32,13 +32,14 @@
* \param[in] rdmult rd multiplier to use in making param choices
*
* \return Nothing is returned. Instead, optimal CDEF parameters are stored
- * in the \c cdef_info structure inside \c cm:
+ * in the \c cdef_info structure of type \ref CdefInfo inside \c cm:
* \arg \c cdef_bits: Bits of strength parameters
* \arg \c nb_cdef_strengths: Number of strength parameters
* \arg \c cdef_strengths: list of \c nb_cdef_strengths strength parameters
* for the luma plane.
* \arg \c uv_cdef_strengths: list of \c nb_cdef_strengths strength parameters
* for the chroma planes.
+ * \arg \c damping_factor: CDEF damping factor.
*
*/
void av1_cdef_search(const YV12_BUFFER_CONFIG *frame,
