Skip to content

Commit d2e1f72

Browse files
authored
deny(missing_docs) for bevy_window (#19655)
# Objective Write some more boilerplate-y docs, to get one crate closer to closing #3492.
1 parent b129764 commit d2e1f72

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

crates/bevy_window/src/event.rs

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,38 +502,66 @@ impl AppLifecycle {
502502
all(feature = "serialize", feature = "bevy_reflect"),
503503
reflect(Serialize, Deserialize)
504504
)]
505-
#[expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
506505
pub enum WindowEvent {
506+
/// An application lifecycle event.
507507
AppLifecycle(AppLifecycle),
508+
/// The user's cursor has entered a window.
508509
CursorEntered(CursorEntered),
510+
///The user's cursor has left a window.
509511
CursorLeft(CursorLeft),
512+
/// The user's cursor has moved inside a window.
510513
CursorMoved(CursorMoved),
514+
/// A file drag and drop event.
511515
FileDragAndDrop(FileDragAndDrop),
516+
/// An Input Method Editor event.
512517
Ime(Ime),
518+
/// A redraw of all of the application's windows has been requested.
513519
RequestRedraw(RequestRedraw),
520+
/// The window's OS-reported scale factor has changed.
514521
WindowBackendScaleFactorChanged(WindowBackendScaleFactorChanged),
522+
/// The OS has requested that a window be closed.
515523
WindowCloseRequested(WindowCloseRequested),
524+
/// A new window has been created.
516525
WindowCreated(WindowCreated),
526+
/// A window has been destroyed by the underlying windowing system.
517527
WindowDestroyed(WindowDestroyed),
528+
/// A window has received or lost focus.
518529
WindowFocused(WindowFocused),
530+
/// A window has been moved.
519531
WindowMoved(WindowMoved),
532+
/// A window has started or stopped being occluded.
520533
WindowOccluded(WindowOccluded),
534+
/// A window's logical size has changed.
521535
WindowResized(WindowResized),
536+
/// A window's scale factor has changed.
522537
WindowScaleFactorChanged(WindowScaleFactorChanged),
538+
/// Sent for windows that are using the system theme when the system theme changes.
523539
WindowThemeChanged(WindowThemeChanged),
524540

541+
/// The state of a mouse button has changed.
525542
MouseButtonInput(MouseButtonInput),
543+
/// The physical position of a pointing device has changed.
526544
MouseMotion(MouseMotion),
545+
/// The mouse wheel has moved.
527546
MouseWheel(MouseWheel),
528547

548+
/// A two finger pinch gesture.
529549
PinchGesture(PinchGesture),
550+
/// A two finger rotation gesture.
530551
RotationGesture(RotationGesture),
552+
/// A double tap gesture.
531553
DoubleTapGesture(DoubleTapGesture),
554+
/// A pan gesture.
532555
PanGesture(PanGesture),
533556

557+
/// A touch input state change.
534558
TouchInput(TouchInput),
535559

560+
/// A keyboard input.
536561
KeyboardInput(KeyboardInput),
562+
/// Sent when focus has been lost for all Bevy windows.
563+
///
564+
/// Used to clear pressed key state.
537565
KeyboardFocusLost(KeyboardFocusLost),
538566
}
539567

0 commit comments

Comments
 (0)