modal: fix comments

This commit is contained in:
ardocrat 2023-08-03 17:38:17 +03:00
parent c66b44db9b
commit 7333da63bd

View file

@ -48,7 +48,7 @@ impl Modal {
/// Maximum width of the content. /// Maximum width of the content.
const DEFAULT_WIDTH: f32 = Root::SIDE_PANEL_WIDTH - (2.0 * Self::DEFAULT_MARGIN); const DEFAULT_WIDTH: f32 = Root::SIDE_PANEL_WIDTH - (2.0 * Self::DEFAULT_MARGIN);
/// Create opened and closeable Modal with center position. /// Create opened and closeable [`Modal`] with center position.
pub fn new(id: &'static str) -> Self { pub fn new(id: &'static str) -> Self {
Self { Self {
id, id,
@ -103,8 +103,8 @@ impl Modal {
w_nav.modal = Some(self); w_nav.modal = Some(self);
} }
/// Remove [`Modal`] from [`MODAL_STATE`] if it's showing and can be closed. /// Remove [`Modal`] from [`ModalState`] if it's showing and can be closed.
/// Return `false` if Modal existed in [`MODAL_STATE`] before call. /// Return `false` if Modal existed in [`ModalState`] before call.
pub fn on_back() -> bool { pub fn on_back() -> bool {
let mut w_state = MODAL_STATE.write().unwrap(); let mut w_state = MODAL_STATE.write().unwrap();
@ -119,7 +119,7 @@ impl Modal {
true true
} }
/// Return id of opened [`Modal`] or remove its instance from [`MODAL_STATE`] if it was closed. /// Return id of opened [`Modal`] or remove its instance from [`ModalState`] if it was closed.
pub fn opened() -> Option<&'static str> { pub fn opened() -> Option<&'static str> {
// Check if Modal is showing. // Check if Modal is showing.
{ {
@ -251,7 +251,7 @@ impl Modal {
ui.painter().set(bg_idx, bg_shape); ui.painter().set(bg_idx, bg_shape);
} }
/// Draw the title. /// Draw title content.
fn title_ui(&self, ui: &mut egui::Ui) { fn title_ui(&self, ui: &mut egui::Ui) {
let rect = ui.available_rect_before_wrap(); let rect = ui.available_rect_before_wrap();