more docs

lvgl · Mar 2, 2023 · e186af9 · e186af9
1 parent aab737a
commit e186af9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/lvgl/src/display.rs b/lvgl/src/display.rs
@@ -7,6 +7,7 @@ use core::mem::MaybeUninit;
 use core::ptr::NonNull;
 use core::{ptr, result};
 
+/// Error in interacting with a `Display`.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 pub enum DisplayError {
     NotAvailable,

diff --git a/lvgl/src/functions.rs b/lvgl/src/functions.rs
@@ -5,6 +5,7 @@ use core::ptr::NonNull;
 use core::time::Duration;
 use core::{ptr, result};
 
+/// Internal LVGL error.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 pub enum CoreError {
     ResourceNotAvailable,

diff --git a/lvgl/src/support.rs b/lvgl/src/support.rs
@@ -8,6 +8,7 @@ use embedded_graphics::pixelcolor::{Rgb565, Rgb888};
 
 pub type LvResult<T> = Result<T, LvError>;
 
+/// Generic LVGL error. All other errors can be coerced into it.
 #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
 pub enum LvError {
     InvalidReference,
@@ -253,6 +254,7 @@ impl From<Align> for u8 {
     }
 }
 
+/// Boolean for determining whether animations are enabled.
 pub enum Animation {
     ON,
     OFF,