aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorchemicstry <[email protected]>2022-07-27 01:30:32 +0300
committerchemicstry <[email protected]>2022-07-27 01:30:32 +0300
commitb1f0d6320e004b53260914c5855c37dc004244c2 (patch)
treed91b82bb937a70e7d9652801d23621a4d1da66b7
parent046778fc53fb996445948e0cb98aaa4253fe8201 (diff)
Improve `set_vref` docs
-rw-r--r--embassy-stm32/src/adc/v2.rs2
-rw-r--r--embassy-stm32/src/adc/v3.rs2
-rw-r--r--embassy-stm32/src/adc/v4.rs2
3 files changed, 3 insertions, 3 deletions
diff --git a/embassy-stm32/src/adc/v2.rs b/embassy-stm32/src/adc/v2.rs
index a74c00979..9244e5d8b 100644
--- a/embassy-stm32/src/adc/v2.rs
+++ b/embassy-stm32/src/adc/v2.rs
@@ -196,7 +196,7 @@ where
196 self.resolution = resolution; 196 self.resolution = resolution;
197 } 197 }
198 198
199 /// Set VREF, which is used for [to_millivolts()] conversion. 199 /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion.
200 /// 200 ///
201 /// Use this if you have a known precise VREF (VDDA) pin reference voltage. 201 /// Use this if you have a known precise VREF (VDDA) pin reference voltage.
202 pub fn set_vref(&mut self, vref: u32) { 202 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 32e115fa1..d8cac0724 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> {
318 self.resolution = resolution; 318 self.resolution = resolution;
319 } 319 }
320 320
321 /// Set VREF used for [to_millivolts()] conversion. 321 /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion.
322 /// 322 ///
323 /// Use this if you have a known precise VREF (VDDA) pin reference voltage. 323 /// Use this if you have a known precise VREF (VDDA) pin reference voltage.
324 pub fn set_vref(&mut self, vref: u32) { 324 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 0950b4661..cc210a6d0 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> {
467 self.resolution = resolution; 467 self.resolution = resolution;
468 } 468 }
469 469
470 /// Set VREF used for [to_millivolts()] conversion. 470 /// Set VREF value in millivolts. This value is used for [to_millivolts()] sample conversion.
471 /// 471 ///
472 /// Use this if you have a known precise VREF (VDDA) pin reference voltage. 472 /// Use this if you have a known precise VREF (VDDA) pin reference voltage.
473 pub fn set_vref(&mut self, vref: u32) { 473 pub fn set_vref(&mut self, vref: u32) {