Skip to content

Add documentation comments for Theme trait implementations and methods #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
quantdale merged 1 commit into from
Jul 22, 2026
Merged

Add documentation comments for Theme trait implementations and methods #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/theme.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ pub enum Theme {
}

impl Theme {
/// Returns a static slice of all available themes in order. Used to populate the theme selector dropdown.
pub fn all() -> &'static [Theme] {
&[
Theme::Dark,
Expand Down Expand Up @@ -94,6 +95,7 @@ impl Theme {
]
}

/// Generates the complete egui::Visuals color scheme for this theme. Applied to egui context each frame.
pub fn visuals(self) -> egui::Visuals {
match self {
Theme::Dark => dark_theme(),
Expand Down Expand Up @@ -137,6 +139,7 @@ impl Theme {
}
}

/// Converts a theme to its human-readable display string (e.g., "Solarized Dark"). Used in UI dropdowns and config serialization.
impl fmt::Display for Theme {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Expand Down Expand Up @@ -181,6 +184,7 @@ impl fmt::Display for Theme {
}
}

/// Parses a theme name from config.json (case-insensitive, handles underscores/spaces). Returns Err(()) on unknown theme.
impl FromStr for Theme {
type Err = ();

Expand Down
Loading