Document free functions

Nate Butler created 2 years ago

Change summary

crates/ui/src/components/popover_menu.rs     | 1 +
crates/ui/src/components/right_click_menu.rs | 1 +
crates/ui/src/components/stack.rs            | 8 ++------
3 files changed, 4 insertions(+), 6 deletions(-)

Detailed changes

crates/ui/src/components/popover_menu.rs

@@ -108,6 +108,7 @@ impl<M: ManagedView> PopoverMenu<M> {
     }
 }
 
+/// Creates a [PopoverMenu]
 pub fn popover_menu<M: ManagedView>(id: impl Into<ElementId>) -> PopoverMenu<M> {
     PopoverMenu {
         id: id.into(),

crates/ui/src/components/right_click_menu.rs

@@ -39,6 +39,7 @@ impl<M: ManagedView> RightClickMenu<M> {
     }
 }
 
+/// Creates a [RightClickMenu]
 pub fn right_click_menu<M: ManagedView>(id: impl Into<ElementId>) -> RightClickMenu<M> {
     RightClickMenu {
         id: id.into(),

crates/ui/src/components/stack.rs

@@ -2,17 +2,13 @@ use gpui::{div, Div};
 
 use crate::StyledExt;
 
-/// Horizontally stacks elements.
-///
-/// Sets `flex()`, `flex_row()`, `items_center()`
+/// Horizontally stacks elements. Sets `flex()`, `flex_row()`, `items_center()`
 #[track_caller]
 pub fn h_stack() -> Div {
     div().h_flex()
 }
 
-/// Vertically stacks elements.
-///
-/// Sets `flex()`, `flex_col()`
+/// Vertically stacks elements. Sets `flex()`, `flex_col()`
 #[track_caller]
 pub fn v_stack() -> Div {
     div().v_flex()