Document more enums

Nate Butler created 2 years ago

Change summary

crates/ui/src/components/button/button_like.rs | 4 ++--
crates/ui/src/components/divider.rs            | 1 +
crates/ui/src/styled_ext.rs                    | 7 ++++---
crates/ui/src/styles/color.rs                  | 1 +
crates/ui/src/styles/elevation.rs              | 1 +
crates/ui/src/styles/typography.rs             | 1 +
6 files changed, 10 insertions(+), 5 deletions(-)

Detailed changes

crates/ui/src/components/button/button_like.rs

@@ -95,6 +95,7 @@ impl From<ButtonStyle> for Color {
     }
 }
 
+/// Sets the visual appearance of a button.
 #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Default)]
 pub enum ButtonStyle {
     /// A filled button with a solid background color. Provides emphasis versus
@@ -262,8 +263,7 @@ impl ButtonStyle {
     }
 }
 
-/// ButtonSize can also be used to help build  non-button elements
-/// that are consistently sized with buttons.
+/// Sets the height of a button. Can also be used to size  non-button elements to align with [Button]s.
 #[derive(Default, PartialEq, Clone, Copy)]
 pub enum ButtonSize {
     Large,

crates/ui/src/components/divider.rs

@@ -7,6 +7,7 @@ enum DividerDirection {
     Vertical,
 }
 
+/// Sets the color of a [Divider].
 #[derive(Default)]
 pub enum DividerColor {
     Border,

crates/ui/src/styled_ext.rs

@@ -30,6 +30,7 @@ pub trait StyledExt: Styled + Sized {
         self.flex().flex_col()
     }
 
+    /// Sets the text size using a [UiTextSize].
     fn text_ui_size(self, size: UiTextSize) -> Self {
         self.text_size(size.rems())
     }
@@ -40,7 +41,7 @@ pub trait StyledExt: Styled + Sized {
     ///
     /// Note: The absolute size of this text will change based on a user's `ui_scale` setting.
     ///
-    /// Use [`text_ui_sm`] for regular-sized text.
+    /// Use `text_ui_sm` for smaller text.
     fn text_ui(self) -> Self {
         self.text_size(UiTextSize::default().rems())
     }
@@ -51,7 +52,7 @@ pub trait StyledExt: Styled + Sized {
     ///
     /// Note: The absolute size of this text will change based on a user's `ui_scale` setting.
     ///
-    /// Use [`text_ui`] for regular-sized text.
+    /// Use `text_ui` for regular-sized text.
     fn text_ui_sm(self) -> Self {
         self.text_size(UiTextSize::Small.rems())
     }
@@ -62,7 +63,7 @@ pub trait StyledExt: Styled + Sized {
     ///
     /// Note: The absolute size of this text will change based on a user's `ui_scale` setting.
     ///
-    /// Use [`text_ui`] for regular-sized text.
+    /// Use `text_ui` for regular-sized text.
     fn text_ui_xs(self) -> Self {
         self.text_size(UiTextSize::XSmall.rems())
     }

crates/ui/src/styles/color.rs

@@ -1,6 +1,7 @@
 use gpui::{Hsla, WindowContext};
 use theme::ActiveTheme;
 
+/// Sets a color that has a consistent meaning across all themes.
 #[derive(Debug, Default, PartialEq, Copy, Clone)]
 pub enum Color {
     #[default]

crates/ui/src/styles/elevation.rs

@@ -85,6 +85,7 @@ impl LayerIndex {
     }
 }
 
+/// Sets ann appropriate z-index for the given layer based on it's intended useage.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum ElementIndex {
     Effect,

crates/ui/src/styles/typography.rs

@@ -38,6 +38,7 @@ impl UiTextSize {
     }
 }
 
+/// Sets the size of a [Headline] element
 #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Default)]
 pub enum HeadlineSize {
     XSmall,