From: Angie Chiang <angiebird@google.com>
Date: Sat, 14 Nov 2020 03:40:13 +0000 (-0800)
Subject: Add doxygen for vpx_rc_config
X-Git-Tag: v1.10.0-rc1~36
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a7731ba488202ea62adfedf3fb49477cafe80b88;p=libvpx

Add doxygen for vpx_rc_config

Bug: webm:1707

Change-Id: I65bab6b2b792653e70cb136a5f9a21796e34b829
---

diff --git a/vpx/vpx_ext_ratectrl.h b/vpx/vpx_ext_ratectrl.h
index 494b14955..bc0ed9819 100644
--- a/vpx/vpx_ext_ratectrl.h
+++ b/vpx/vpx_ext_ratectrl.h
@@ -221,16 +221,18 @@ typedef struct vpx_rc_firstpass_stats {
   int num_frames;
 } vpx_rc_firstpass_stats_t;
 
-/*!\cond
-  TODO(angiebird): document these structures and fields to clear doxygen
-  warnings.*/
+/*!\brief Encode config sent to external rate control model
+ */
 typedef struct vpx_rc_config {
-  int frame_width;
-  int frame_height;
-  int show_frame_count;
+  int frame_width;      /**< frame width */
+  int frame_height;     /**< frame height */
+  int show_frame_count; /**< number of visible frames in the video */
+  /*!
+   * Target bitrate in kilobytes per second
+   */
   int target_bitrate_kbps;
-  int frame_rate_num;
-  int frame_rate_den;
+  int frame_rate_num; /**< numerator of frame rate */
+  int frame_rate_den; /**< denominator of frame rate */
 } vpx_rc_config_t;
 
 /*!\brief Create an external rate control model callback prototype
@@ -295,6 +297,10 @@ typedef vpx_rc_status_t (*vpx_rc_update_encodeframe_result_cb_fn_t)(
 typedef vpx_rc_status_t (*vpx_rc_delete_model_cb_fn_t)(
     vpx_rc_model_t rate_ctrl_model);
 
+/*!\cond
+  TODO(angiebird): document these structures and fields to clear doxygen
+  warnings.*/
+
 typedef struct vpx_rc_funcs {
   vpx_rc_create_model_cb_fn_t create_model;
   vpx_rc_send_firstpass_stats_cb_fn_t send_firstpass_stats;