Update docs of windows-specific methods (#281)

This commit is contained in:
pravic 2017-09-13 10:19:54 +03:00 committed by tomaka
parent 59c33d2c6a
commit c82fcd203f

View file

@ -8,11 +8,9 @@ use winapi;
/// Additional methods on `Window` that are specific to Windows. /// Additional methods on `Window` that are specific to Windows.
pub trait WindowExt { pub trait WindowExt {
/// Returns a pointer to the `Window` object of xlib that is used by this window. /// Returns the native handle that is used by this window.
/// ///
/// Returns `None` if the window doesn't use xlib (if it uses wayland for example). /// The pointer will become invalid when the native window was destroyed.
///
/// The pointer will become invalid when the glutin `Window` is destroyed.
fn get_hwnd(&self) -> *mut libc::c_void; fn get_hwnd(&self) -> *mut libc::c_void;
} }
@ -29,7 +27,7 @@ pub trait WindowBuilderExt {
} }
impl WindowBuilderExt for WindowBuilder { impl WindowBuilderExt for WindowBuilder {
/// Sets a parent to the window to be created /// Sets a parent to the window to be created.
#[inline] #[inline]
fn with_parent_window(mut self, parent: winapi::HWND) -> WindowBuilder { fn with_parent_window(mut self, parent: winapi::HWND) -> WindowBuilder {
self.platform_specific.parent = Some(parent); self.platform_specific.parent = Some(parent);