From 412e414198307e6e787742731759d153fdfc5b20 Mon Sep 17 00:00:00 2001
From: "Wladimir J. van der Laan" <laanwj@protonmail.com>
Date: Fri, 7 Feb 2020 18:02:40 +0000
Subject: [PATCH] rust: Add comment

---
 rust/k210-shared/src/board/lcd.rs | 6 ++++++
 rust/k210-shared/src/util.rs      | 1 +
 2 files changed, 7 insertions(+)

diff --git a/rust/k210-shared/src/board/lcd.rs b/rust/k210-shared/src/board/lcd.rs
index f2f4495..67730d8 100644
--- a/rust/k210-shared/src/board/lcd.rs
+++ b/rust/k210-shared/src/board/lcd.rs
@@ -143,10 +143,16 @@ pub trait LCDLL {
 
 /** High-level interface */
 pub trait LCDHL {
+    /** Turn on and initialize the LCD display, this needs to be called before it's possible to use it. */
     fn init(&mut self);
+    /** Set direction/alignment of display. It can be rotated and/or mirrored in every direction. */
     fn set_direction(&mut self, dir: direction);
+    /** Clear the screen to a single RGB565 color. */
     fn clear(&self, color: u16);
+    /** Draw a picture, filling the entire screen or part of it. `data` packs two RGB565 pixels
+     * per u32 as 0xAAAABBBB. */
     fn draw_picture(&self, x1: u16, y1: u16, width: u16, height: u16, data: &[u32]);
+    /** Shut down and turn off the screen. */
     fn shutdown(&mut self);
 }
 
diff --git a/rust/k210-shared/src/util.rs b/rust/k210-shared/src/util.rs
index 2589ce3..ecbb6dc 100644
--- a/rust/k210-shared/src/util.rs
+++ b/rust/k210-shared/src/util.rs
@@ -1 +1,2 @@
+/** Internal utilities. */
 pub mod filters;