summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAgathe Porte <microjoe@microjoe.org>2020-02-27 12:53:21 +0100
committerAgathe Porte <microjoe@microjoe.org>2020-02-27 12:53:21 +0100
commitf565f3fcacdf94a58ab97b41b12849f491e2dce2 (patch)
treecaa27f9a26027a1ae3d031034eaca0071b3833ee /src
parent9df0a6e9061d65220df91578e7442a75a9727361 (diff)
downloadcharlcd-f565f3fcacdf94a58ab97b41b12849f491e2dce2.tar.gz
charlcd-f565f3fcacdf94a58ab97b41b12849f491e2dce2.zip
lib: improve doc of flash_backlight
Diffstat (limited to 'src')
-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)
}