History

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

vpx/vpx_ext_ratectrl.h+14−8
@@ -221,16 +221,18 @@ typedef struct vpx_rc_firstpass_stats { · 220 unmodified lines
221221 int num_frames;
222222 } vpx_rc_firstpass_stats_t;
223223
224−/*!\cond
225− TODO(angiebird): document these structures and fields to clear doxygen
226− warnings.*/
224+/*!\brief Encode config sent to external rate control model
225+ */
227226 typedef struct vpx_rc_config {
228− int frame_width;
229− int frame_height;
230− int show_frame_count;
227+ int frame_width; /**< frame width */
228+ int frame_height; /**< frame height */
229+ int show_frame_count; /**< number of visible frames in the video */
230+ /*!
231+ * Target bitrate in kilobytes per second
232+ */
231233 int target_bitrate_kbps;
232− int frame_rate_num;
233− int frame_rate_den;
234+ int frame_rate_num; /**< numerator of frame rate */
235+ int frame_rate_den; /**< denominator of frame rate */
234236 } vpx_rc_config_t;
235237
236238 /*!\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)( · 58 unmodified lines
295297 typedef vpx_rc_status_t (*vpx_rc_delete_model_cb_fn_t)(
296298 vpx_rc_model_t rate_ctrl_model);
297299
300+/*!\cond
301+ TODO(angiebird): document these structures and fields to clear doxygen
302+ warnings.*/
303+
298304 typedef struct vpx_rc_funcs {
299305 vpx_rc_create_model_cb_fn_t create_model;
300306 vpx_rc_send_firstpass_stats_cb_fn_t send_firstpass_stats;

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t