Documentation

crates/egui/src/memory.rs

@@ -1103,11 +1103,17 @@ impl Areas {
     }
 }
 
-#[derive(Clone, Copy, PartialEq, Eq, Hash)]
+/// Which theme should egui use?
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 pub enum ThemePreference {
+    /// Dark mode: light text on a dark background.
     Dark,
+
+    /// Light mode: dark text on a light background.
     Light,
+
+    /// Follow the system's theme preference.
     System,
 }
 

crates/egui/src/widgets/theme_switch/mod.rs

@@ -1,15 +1,17 @@
+use crate::{Painter, Response, ThemePreference, Ui, Widget};
 use emath::{Pos2, Rect};
 use epaint::Color32;
 
-use crate::{Painter, Response, ThemePreference, Ui, Widget};
-
 mod arc;
 mod cogwheel;
 mod moon;
 mod rotated_rect;
 mod sun;
 
+/// A switch control that allows choosing the theme
+/// preference (dark, light or follow system).
 #[must_use = "You should put this widget in an ui with `ui.add(widget);`"]
+#[derive(Debug)]
 pub struct ThemeSwitch<'a> {
     value: &'a mut ThemePreference,
     show_follow_system: bool,