From 6ca7e0feab9eb16261adacc8c2327e4d018acb13 Mon Sep 17 00:00:00 2001
From: Torin Cooper-Bennun <tcbennun@maxiluxsystems.com>
Date: Tue, 23 Apr 2024 12:33:20 +0100
Subject: [PATCH] stm32: can: fd: fix a couple doc comments
---
embassy-stm32/src/can/fdcan.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/embassy-stm32/src/can/fdcan.rs b/embassy-stm32/src/can/fdcan.rs
index 0916f6ac6..0df74a778 100644
--- a/embassy-stm32/src/can/fdcan.rs
+++ b/embassy-stm32/src/can/fdcan.rs
@@ -289,7 +289,7 @@ pub struct Can<'d, T: Instance> {
}
impl<'d, T: Instance> Can<'d, T> {
- /// Get properties
+ /// Get driver properties
pub fn properties(&self) -> &Properties<T> {
&self.properties
}
@@ -338,7 +338,7 @@ impl<'d, T: Instance> Can<'d, T> {
T::state().rx_mode.read_fd::<T>().await
}
- /// Split instance into separate Tx(write) and Rx(read) portions
+ /// Split instance into separate portions: Tx(write), Rx(read), common properties
pub fn split(self) -> (CanTx<'d, T>, CanRx<'d, T>, Properties<T>) {
(
CanTx {