dan/cushy
1
0
Fork 0
mirror of https://github.com/danbulant/cushy synced 2026-07-05 11:10:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix some docstrings in window module

Browse source
This commit is contained in:
Fabian Keller 2024-10-22 09:57:39 +02:00
parent f08b7064ec
commit 76fb062107
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/window.rs
View file

@ -117,7 +117,7 @@ pub trait PlatformWindowImplementation {
self.winit().map_or(true, |win| win.is_resizable()) self.winit().map_or(true, |win| win.is_resizable())
} }
/// Returns true if the window can have its size changed. /// Returns the underlying window theme.
/// ///
/// The provided implementation returns [`winit::window::Window::theme`], or /// The provided implementation returns [`winit::window::Window::theme`], or
/// dark if this window has no winit window. /// dark if this window has no winit window.
@ -248,7 +248,7 @@ pub trait PlatformWindow {
fn handle(&self) -> WindowHandle; fn handle(&self) -> WindowHandle;
/// Returns the unique id of the [`Kludgine`] instance used by this window. /// Returns the unique id of the [`Kludgine`] instance used by this window.
fn kludgine_id(&self) -> KludgineId; fn kludgine_id(&self) -> KludgineId;
/// Returns the dynamic that is synchrnoized with the window's focus. /// Returns the dynamic that is synchronized with the window's focus.
fn focused(&self) -> &Dynamic<bool>; fn focused(&self) -> &Dynamic<bool>;
/// Returns the dynamic that is synchronized with the window's occlusion /// Returns the dynamic that is synchronized with the window's occlusion
/// status. /// status.
@ -800,7 +800,7 @@ where
self self
} }
/// Sets `position` to be a dynamic synchronized with this window's outer /// Sets `position` to be a dynamic synchronized with this window's outer
/// position. /// position.
/// ///
/// If `automatic_layout` is true, the initial value of `position` will be /// If `automatic_layout` is true, the initial value of `position` will be
@ -829,7 +829,7 @@ where
self self
} }
/// Sets `position` to be a dynamic synchronized with this window's inner /// Sets `position` to be a dynamic synchronized with this window's inner
/// position. /// position.
/// ///
/// When the window is moved, this dynamic will contain its new position. /// When the window is moved, this dynamic will contain its new position.