aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank Plowman <[email protected]>2024-08-09 14:15:23 +0100
committerFrank Plowman <[email protected]>2024-08-09 14:17:54 +0100
commit0eb07896275f26f1206ed968436d1f0e78a163b8 (patch)
treea23af6ba8065d7c8a9ec43bdbd993dc1fe16cc77
parentb55726c515f366896b58f46f3322821f1bdf1993 (diff)
nrf, doc: Don't refer to `Default` impl of `saadc::ChannelConfig`
`saadc::ChannelConfig` does not implement the `Default` trait, so its documentation should not refer to it. Modify the documentation to instead describe how the struct should be created and configured.
-rw-r--r--embassy-nrf/src/saadc.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/embassy-nrf/src/saadc.rs b/embassy-nrf/src/saadc.rs
index a3a5b9cfe..bbfa9b3b9 100644
--- a/embassy-nrf/src/saadc.rs
+++ b/embassy-nrf/src/saadc.rs
@@ -78,7 +78,8 @@ impl Default for Config {
78 78
79/// Used to configure an individual SAADC peripheral channel. 79/// Used to configure an individual SAADC peripheral channel.
80/// 80///
81/// See the `Default` impl for suitable default values. 81/// Construct using the `single_ended` or `differential` methods. These provide sensible defaults
82/// for the public fields, which can be overridden if required.
82#[non_exhaustive] 83#[non_exhaustive]
83pub struct ChannelConfig<'d> { 84pub struct ChannelConfig<'d> {
84 /// Reference voltage of the SAADC input. 85 /// Reference voltage of the SAADC input.