summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRomain Porte <microjoe@microjoe.org>2020-02-27 12:53:21 +0100
committerRomain Porte <microjoe@microjoe.org>2020-02-27 12:53:21 +0100
commit59fd9ab37bc30d10b63da1cdedea6ee0e7452bb4 (patch)
treea222841dbcddb54361df214565fa104857a7dfc7
parent5026b558ff56d25a6fb93abeec7580ab90f79e67 (diff)
downloadcharlcd-59fd9ab37bc30d10b63da1cdedea6ee0e7452bb4.tar.gz
charlcd-59fd9ab37bc30d10b63da1cdedea6ee0e7452bb4.zip
lib: improve doc of flash_backlight
-rw-r--r--src/lib.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 0eacbfc..26b498a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -169,7 +169,8 @@ where
/// Flash the backlight during a small duration.
///
/// The exact duration is specified in the driver. As of today, the default
- /// value is set to 4 seconds (`LCD_BL_TEMPO_PERIOD` define in `charlcd.c`).
+ /// value is set to 4 seconds (see the `LCD_BL_TEMPO_PERIOD` define of
+ /// the `charlcd.c` driver in your Linux tree).
pub fn flash_backlight(&mut self) -> std::io::Result<()> {
write_simple_code!(self, SpecialCode::FlashBacklight)
}