Add doxygen for vpx_rc_config

Bug: webm:1707

Angie Chiang committed 6 years ago

Commit a7731ba1 parent c22a7831 file · +14 −8Browse files

Unified · Split

   int num_frames;
 } vpx_rc_firstpass_stats_t;
-/*!\cond
+/*!\brief Encode config sent to external rate control model
-  TODO(angiebird): document these structures and fields to clear doxygen
+ */
-  warnings.*/
 typedef struct vpx_rc_config {
-  int frame_width;
+  int frame_width;      /**< frame width */
-  int frame_height;
+  int frame_height;     /**< frame height */
-  int show_frame_count;
+  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_num; /**< numerator of frame rate */
-  int frame_rate_den;
+  int frame_rate_den; /**< denominator of frame rate */
 } vpx_rc_config_t;
 /*!\brief Create an external rate control model callback prototype
 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;

Keyboard shortcuts