Skip to content

Commit ef7a66a

Browse files
vibhoothilu-zero
authored andcommitted
Document EncoderConfig v2
1 parent fd137e9 commit ef7a66a

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/api.rs

+9-4
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,10 @@ pub struct EncoderConfig {
8585
pub train_rdo: bool,
8686
}
8787

88-
/// Default preset for EncoderConfig,it is a balance between quality and speed.
89-
/// User can use with_speed_preset to have a default structure with a specific speed level.
88+
/// Default preset for EncoderConfig: it is a balance between quality and speed.
89+
/// See [`with_speed_preset()`]
90+
///
91+
/// [`with_speed_preset()`]: struct.EncoderConfig.html#method.with_speed_preset
9092
impl Default for EncoderConfig {
9193
fn default() -> Self {
9294
const DEFAULT_SPEED: usize = 5;
@@ -96,8 +98,11 @@ impl Default for EncoderConfig {
9698

9799
impl EncoderConfig {
98100

99-
/// This is a preset which provides default settings according to a speed value in the specific range 0-10,
100-
/// If the input value is greater than 10 will result in the same setting like 10.
101+
/// This is a preset which provides default settings according to a speed value in the specific range 0-10.
102+
/// For each speed value it is having different preset. See [`from_preset()`].
103+
/// If the input value is greater than 10, it will result in the same settings of 10.
104+
///
105+
/// [`from_preset()`]: struct.SpeedSettings.html#method.from_preset
101106
pub fn with_speed_preset(speed: usize) -> Self {
102107
EncoderConfig {
103108
width: 640,

0 commit comments

Comments
 (0)