diff options
| author | chemicstry <chemicstry@gmail.com> | 2022-07-27 01:30:32 +0300 |
|---|---|---|
| committer | chemicstry <chemicstry@gmail.com> | 2022-07-27 01:30:32 +0300 |
| commit | b1f0d6320e004b53260914c5855c37dc004244c2 (patch) | |
| tree | d91b82bb937a70e7d9652801d23621a4d1da66b7 /embassy-stm32 | |
| parent | 046778fc53fb996445948e0cb98aaa4253fe8201 (diff) | |
| download | embassy-b1f0d6320e004b53260914c5855c37dc004244c2.zip | |
Improve `set_vref` docs
Diffstat (limited to 'embassy-stm32')
| -rw-r--r-- | embassy-stm32/src/adc/v2.rs | 2 | ||||
| -rw-r--r-- | embassy-stm32/src/adc/v3.rs | 2 | ||||
| -rw-r--r-- | embassy-stm32/src/adc/v4.rs | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/embassy-stm32/src/adc/v2.rs b/embassy-stm32/src/adc/v2.rs index a74c0097..9244e5d8 100644 --- a/embassy-stm32/src/adc/v2.rs +++ b/embassy-stm32/src/adc/v2.rs @@ -196,7 +196,7 @@ where self.resolution = resolution; } - /// Set VREF, which is used for [to_millivolts()] conversion. + /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion. /// /// Use this if you have a known precise VREF (VDDA) pin reference voltage. pub fn set_vref(&mut self, vref: u32) { diff --git a/embassy-stm32/src/adc/v3.rs b/embassy-stm32/src/adc/v3.rs index 32e115fa..d8cac072 100644 --- a/embassy-stm32/src/adc/v3.rs +++ b/embassy-stm32/src/adc/v3.rs @@ -318,7 +318,7 @@ impl<'d, T: Instance> Adc<'d, T> { self.resolution = resolution; } - /// Set VREF used for [to_millivolts()] conversion. + /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion. /// /// Use this if you have a known precise VREF (VDDA) pin reference voltage. pub fn set_vref(&mut self, vref: u32) { diff --git a/embassy-stm32/src/adc/v4.rs b/embassy-stm32/src/adc/v4.rs index 0950b466..cc210a6d 100644 --- a/embassy-stm32/src/adc/v4.rs +++ b/embassy-stm32/src/adc/v4.rs @@ -467,7 +467,7 @@ impl<'d, T: Instance + crate::rcc::RccPeripheral> Adc<'d, T> { self.resolution = resolution; } - /// Set VREF used for [to_millivolts()] conversion. + /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion. /// /// Use this if you have a known precise VREF (VDDA) pin reference voltage. pub fn set_vref(&mut self, vref: u32) { |